MkDocs
Nikolaj Ivancic
Dec 5, 2020
0 views0
CommentsWhat is MkDocs?
It builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose. There's a stack of good looking themes available. The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.
MkDocs is a tool in the Frameworks category of a tech stack.
MkDocs Pros & Cons
Pros of MkDocs
- ✓Speed
- ✓Gitlab integration
- ✓Extensibility
- ✓Themes
Cons of MkDocs
- ✗Build time increases exponentially as site grows
MkDocs Alternatives & Comparisons
What are some alternatives to MkDocs?
Gatsby
Gatsby lets you build blazing fast sites with your data, whatever the source. Liberate your sites from legacy CMSs and fly into the future.
Jekyll
Think of Jekyll as a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind GitHub Pages, which you can use to host sites right from your GitHub repositories.
Hugo
Hugo is a static site generator written in Go. It is optimized for speed, easy use and configurability. Hugo takes a directory with content and templates and renders them into a full html website. Hugo makes use of markdown files with front matter for meta data.
