adulau/review-doc-tool.md

Last active July 8, 2023 15:02

Star (6) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/adulau/50309aabdf8b072bf83ab4882313884b.js"></script>
Save adulau/50309aabdf8b072bf83ab4882313884b to your computer and use it in GitHub Desktop.

Download ZIP

Review of documentation generator open source tool

Raw

review-doc-tool.md

Tools

GitBook

A good one (PDF, EPUB export included) but the project is halted and moved to a proprietary model. https://github.com/GitbookIO/gitbook What is the best fork to use?

Docusaurus

https://docusaurus.io/

Looks nice and neat (you need a lot of JS to view doc, less nice) but cannot find a simple way to generate PDF or EPUB.

mkdocs

https://www.mkdocs.org/

Simple and minimal, using Python very nice. But still not default PDF export. There is a pandoc module (unmaintained?) https://github.com/jgrassler/mkdocs-pandoc

docsify

https://github.com/docsifyjs/docsify

Looks nice (but again too much JS to view it?). Generating static content seems more complex.

Madoko

Not sure I understand the concept...

https://www.madoko.net/

Slate (API documentation)

It seems pretty good for API documentation.

https://github.com/lord/slate

NaturalDocs

Looks good but mainly focus on code readability. It seems useful for documenting code.

https://www.naturaldocs.org

Daux.io

https://github.com/dauxio/daux.io

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment