Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Tool to generate technical documentation website from markdown

I'm looking for a tool to generate a static website to host some internal documentation, like dev tips, tools we use, a few simple tutorials etc.. The idea being to share it among the team, rather informally.

I'm sure there are many tools out there, and it's actually pretty overwhelming to try and choose one. rmarkdown / blogdown look pretty cool but I had never heard of it before. Github Markdown Render seems interesting (but not static), there are certainly hundreds of tools for blogs, and lots to generate sites from code (Sphinx, Doxygen).

More specific requirement :

  • As simple as possible, ideally creating the website files in one command line. We don't need a full blown WordPress setup.
  • Nice rendering, especially for code. I love Github rendering for ex.
  • Possibility to navigate between files.
  • Well supported / big community.
  • If possible, customizable for looks and a to give more control on layout etc.. Not a priority though.
  • General enough so that I can change tool if someday I decide I want finer control.

Do you guys have any recommendations?

PS : I chose markdown because it seems to be the most common and I already know / use it, but I'm open to rest or anything.

like image 863
Big Bro Avatar asked Aug 09 '26 14:08

Big Bro


1 Answers

docsify might meet your needs.

dosify

docsify-themeable

As simple as possible, ideally creating the website files in one command line.

A docsify site is created in one command.

docsify init ./docs

Possibility to navigate between files.

There is a sidebar to navigate between files.

Well supported / big community.

It's a 17.3k project. There are 160 contributors now(April 16, 2021).

Nice rendering, especially for code.

If possible, customizable for looks and a to give more control on layout.

It's customizable. You can find websites created by docsify and themes for docsify on Awesome Docsify.

General enough so that I can change tool if someday I decide I want finer control.

Don't worry. Many tools support Markdown. You can change the tool whenever you want.

like image 60
Cyrus Yip Avatar answered Aug 15 '26 08:08

Cyrus Yip