Documentation

Documentation Softwares

• Sphinx
  • uses reStructuredText
  • difficult to learn and use
  • handles complex use cases
  • Furo theme good
• MkDocs
  • uses Markdown
  • static site generator (SSG)
  • Material for MkDocs good plugin
• Docusauras
  • by Meta
• Read the docs
  • Hosting site for Sphinx, MkDocs
• Github Pages
  • Hosting Site for SSG websites
• Pandoc
  • convert markdown to PDF
  • can also be used to convert between other formats as well

Diagram as a code

• Mermaid
• PlantUML
• GraphViz

MathJax

• https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference