Discussion

Ask HN: Is there a good framework for an interactive user manual?

I need to deliver a technical user guide for field technicians to follow for configuring some devices. The current solution is a word doc which requires some brain power to fill in appropriate values (naming, IP, etc) as you progress in the steps.

I'd like to replace this with some kind of self-contained HTML where they can fill in the "variables" at the top and have it auto-generate throughout the doc. This is pretty simple with HTML/JS, but the code can get messy if not done right.

Is there some framework like ReadTheDocs where I can easily write out RsT or Markdown, inserting variables with jinja2 (as an example) that can be input in an input field, and have it dynamically render live in-browser (which I believe then rules Sphinx out)?

24 points core-utility 4 years ago 12 comments

Discussion

Live from the official Hacker News API

A modern reader for Hacker News · SvelteKit + Skeleton