Documentation
README
human-review
The user reviews your HTML, Markdown, or localhost page in a real browser: they fix small things by typing, select anything to comment on it, and send you the whole batch at once.
Markdown files open rendered. Their quotes and edits reference the rendered text, and the file itself is never touched — apply every change to the Markdown source, keeping its formatting syntax.
The loop
-
Write or update the HTML or Markdown file, or start the local page being reviewed.
-
Open it for the user:
npx -y human-review path/to/file.htmlFor a page served by a local development server, open the real route instead of recreating it as a separate HTML file:
npx -y human-review http://localhost:3000/wiki
This is the opening of the README. Read the full README on GitHub.