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

• ink

  163 3,878 0.0 C#

  inkle's open source scripting language for writing interactive narrative. (by inkle)

  

  I once wrote a software release checklist system with custom values in php which worked quite well, if you have a server to run it on.

  But I'm not sure thats the best bet for new work today.

  It might be worth looking at interactive fiction tools like twine" rel="nofollow">https://twinery.org">twine or ink" rel="nofollow">https://www.inklestudios.com/ink/">ink

  They sort of do everything you need already including variable ui+storage, javascript processing, html output and save/reload.

• twinejs

  407 1,775 8.5 TypeScript

  Twine, a tool for telling interactive, nonlinear stories

  I once wrote a software release checklist system with custom values in php which worked quite well, if you have a server to run it on.

  But I'm not sure thats the best bet for new work today.

  It might be worth looking at interactive fiction tools like twine" rel="nofollow">https://twinery.org">twine or ink" rel="nofollow">https://www.inklestudios.com/ink/">ink

  They sort of do everything you need already including variable ui+storage, javascript processing, html output and save/reload.

• SurveyJS

  surveyjs.io

  sponsored

  Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.

  

• mkdocs-material

  93 18,123 9.8 HTML

  Documentation that simply works

  You end up with markdown split into logical folders, with a natural flow from each page to the next built in.

  It’s built with python but you don’t need python knowledge at all to build; configure and serve the product.

  The plug-in eco system adds the ability to embed variables into the markdown pages also you can embed html, so d3 visualisation or a vue calculator app will all embed just fine.

  Really clean extensible base, insanely simple and fast to get started oh and free to use. I push mine to GitHub and have that auto build into GitHub pages or a free Netlify account.

  https://squidfunk.github.io/mkdocs-material/

Suggest a related project