mdBook documentation generator

Tools
1

After looking at mdBook some more, I think this checks all my boxes:

  • works well with files in Git
  • direct translation of *.md → *.html
  • single file (SUMMARY.md) to generate the table of contents. This is much nicer than sprinkling meta-data in the actual markdown files which is difficult to update if you want to add a page to a site.
  • converts README.md → index.html
  • link checker

Currently working on converting the Simple IoT documentation to this format.

2

mdBook is part of the Rust project, but appears to be generally useful. There is work being done to make the playground feature work in other languages.