DEV Community

loading...

Some great tools to create a static site from your markdown documentation

Maxime Guilbert
Just a dev who touches a lot of things and wants to share his experiences. (or just want to note somewhere things to don't forget)
Updated on ・1 min read

When we are working on a project, we are writing a lot of documentation about the project, how works the application...

Depending on the documentation, generally technical people need access to, but sometimes you want to let it available for non-technical people. But they don't know how to use github (or don't have the access if it's a private project) or else to go to your markdown files.

So here are useful tools to be able to generate a static website from your markdown files.


MkDocs

Alt Text
WebSite


Read the docs

Alt Text
WebSite


Sphinx

Alt Text
Website


VuePress

Thanks to Socola Đại Ca for this one
Alt Text
Website


Hugo

Thanks to Roneo.org for this one
Alt Text
Website


I hope it will help you!

Discussion (4)

Collapse
roneo profile image
Roneo.Org

I'm using Hugo daily on roneo.org, It's convincing and easily scalable for huge projects. It's often considered as the fastest engine for converting Markdown to HTML

Collapse
adaendra profile image
Maxime Guilbert Author

Thanks for this new reference, I will add it to the post!

Collapse
socoladaica profile image
Socola Đại Ca

I recommend vuepress

Collapse
adaendra profile image
Maxime Guilbert Author

Thanks for this reference, I didn't know it. I will add it to the list