oleks / html-remarks

A zero-install, server-less implementation of remarks

A zero-install, server-less implementation of remarks

This is a zero-install, HTML-resident implementation of remarks. remarks was originally a DSL, but it proves a hassle to have people install software on their systems.

Design

• Zero install for all: Both teachers and students should be able to open a remarks file in their browser.
• Save-and-resume: Manipulate the DOM rather than the JavaScript run-time. This enables saving the file once changes have been made to the document.
• Mobile-first for students: When a remarks file is finalized for student view, this student view should be friendly for view on handheld devices (tablet, or mobile).

TypeScript Style Guide

• Don't use var for non-variables, use let.
• Don't use document.createElement without a wrapper function that hence asserts a type for the created element.
• Always use ===.
• Always specify the return type of a function (especially, if it is void).

html-remarks's Issues

Maintain an edit history

Make it compatible with the browser back-button using anchors.

Implement the "strip history" feature

First, we need #2.

Add git information to the output HTML

Actually have points for judgements

Implement the "strip controls" feature.

Should also strip the history before handing a stripped version to the students (see #9).

Modify-save does not work in Firefox

Finish porting remarks to TypeScript

Provide a guide for keyboard shortcuts

Write a test-suite

Introduce a Remark class

Perform points-accounting

Import/Export JSON

JSON should be easy enough, and this would yield HTML-remarks compatible with the remarks DSL.

Make the generated HTML Git-friendly

Currently appending elements seems to render a one-liner in source 👎

Use cpp to generate a self-contained remarks.html