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

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-tech…


This content originally appeared on DEV Community and was authored by Maxime Guilbert

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

I hope it will help you!


This content originally appeared on DEV Community and was authored by Maxime Guilbert


Print Share Comment Cite Upload Translate Updates
APA

Maxime Guilbert | Sciencx (2021-05-20T11:41:49+00:00) Some great tools to create a static site from your markdown documentation. Retrieved from https://www.scien.cx/2021/05/20/some-great-tools-to-create-a-static-site-from-your-markdown-documentation/

MLA
" » Some great tools to create a static site from your markdown documentation." Maxime Guilbert | Sciencx - Thursday May 20, 2021, https://www.scien.cx/2021/05/20/some-great-tools-to-create-a-static-site-from-your-markdown-documentation/
HARVARD
Maxime Guilbert | Sciencx Thursday May 20, 2021 » Some great tools to create a static site from your markdown documentation., viewed ,<https://www.scien.cx/2021/05/20/some-great-tools-to-create-a-static-site-from-your-markdown-documentation/>
VANCOUVER
Maxime Guilbert | Sciencx - » Some great tools to create a static site from your markdown documentation. [Internet]. [Accessed ]. Available from: https://www.scien.cx/2021/05/20/some-great-tools-to-create-a-static-site-from-your-markdown-documentation/
CHICAGO
" » Some great tools to create a static site from your markdown documentation." Maxime Guilbert | Sciencx - Accessed . https://www.scien.cx/2021/05/20/some-great-tools-to-create-a-static-site-from-your-markdown-documentation/
IEEE
" » Some great tools to create a static site from your markdown documentation." Maxime Guilbert | Sciencx [Online]. Available: https://www.scien.cx/2021/05/20/some-great-tools-to-create-a-static-site-from-your-markdown-documentation/. [Accessed: ]
rf:citation
» Some great tools to create a static site from your markdown documentation | Maxime Guilbert | Sciencx | https://www.scien.cx/2021/05/20/some-great-tools-to-create-a-static-site-from-your-markdown-documentation/ |

Please log in to upload a file.




There are no updates yet.
Click the Upload button above to add an update.

You must be logged in to translate posts. Please log in or register.