DEV Community

Cover image for Documentation Generators - A curated list: MkDocs, Docsify, Vuepress

Documentation Generators - A curated list: MkDocs, Docsify, Vuepress

Sm0ke on December 13, 2020

Hello Coders, This article presents a curated list with modern, open-source documentation generators useful when we want to explain in deep how a ...
Collapse
 
uithemes profile image
ui-themes

Thanks!
Docsify deserves a closer look.

Collapse
 
rxliuli profile image
rxliuli

Both front and back ends of docsify are suitable for use, no nodejs or any other runtime/compilation tools are needed, only html + markdown

Collapse
 
sm0ke profile image
Sm0ke

Thank you for your feedback.
Regarding the search, can you provide more information?
I wonder how the default search feature manages a large index (1k pages or more).

Collapse
 
rxliuli profile image
rxliuli

Currently I have not used docsify to build a large online document (the company has its own wiki system), but the largest online document I have built using it is zhuyanxue.liuli.moe/#/, which contains 404 files , 32878 words, no major problems have been encountered in the search

In addition, you don’t seem to mention hexo/hugo. As far as I know, the official website of vue.js is built using hexo

Thread Thread
 
sm0ke profile image
Sm0ke

Noted.
I will try hexo/hugo - Ty!
The Lighthouse score for Docsify looks a little bit lower than MkDocs (just run it on your deployment).
Any tweaks to improve the score?

Thread Thread
 
rxliuli profile image
rxliuli

Performance is difficult to become a decisive factor in most application scenarios, especially in this era when hardware is worthless. . .

Thread Thread
 
sm0ke profile image
Sm0ke

I'm ok with accessing and consume good documentation rendered by a SPA but Google is the bad guy in this equation.
Anyway, .. this is not a show stopper, for me at least, to use Docsify.

Thanks again for your time!

Collapse
 
Sloan, the sloth mascot
Comment deleted
Collapse
 
sm0ke profile image
Sm0ke

Noted, Ty!

Collapse
 
sm0ke profile image
Sm0ke

Don't see anything related to search. There is a native plugin available?
Ty!

Collapse
 
crearesite profile image
WebsiteMarket

Nice list! Ty!

Collapse
 
jamesgrayalgolia profile image
James Gray

I just wanted to mention that for public technical docs Algolia IS free using DocSearch - docsearch.algolia.com/. Just a small note since I saw this article mentions its not free. Thanks!