Document generator

MD file serve

Excellent Source Ref

jekyll

(used by Github for gh pages)

Main site

Markdown guide jekyll

• https://jekyllrb.com/docs/installation/ubuntu/
• https://jekyllrb.com/docs/
• https://github.com/omc/searchyll (with elastic search)
• https://github.com/planetjekyll/awesome-jekyll-plugins
• https://github.com/benbalter/jekyll-auth

docusaurus

(by facebook)

Main site

• Preferring docusaurus

  • because of node environment & community
  • Extra features like Navigation bar, blogs with tags

• PDF Download Github Issue

• Local search //by lunar.js for internal search

  • https://github.com/the-darc/Docusaurus

• Track main issues //theming

  Note: Nested left menu config, ui, also added more nav bar links & content

  See showcase application -> go to their github docs

• check docusaurus - different side bar for different pages

details (MD)

wiki js

https://wiki.js.org/ (authentication, local search exists)

Other points

• Convert existing word documents to md file using pandoc
• Build time can convert md to pdf to make available for download/ print check markdown-pdf

Other add ons

• using markdown as slides // https://remarkjs.com/ or https://jdan.github.io/cleaver
• markdown in email also // https://www.markdownguide.org/tools/markdown-here/