MkDocs is static site generator designed for building project documentation. It is fast and lightweight and written in Python.
Today I encounter a tool called MkDocs while studying diagram-as-code.
Just like Hugo, mkdocs is also a static site generator that designed for building project documentation.
It converts my markdown (.md) files into HTML pages.
Tutorial#
To get start, follow the video (by James). Or simply check out the his blog post at Getting Started with Material for MkDocs.
By following the video and blog post, I manage to complete a project:
- Create all the contents as
markdownfiles (.md). - Setup dynamic colour scheme.
- Customizing icons, logos, custom code blocks, content tabs, and more.
- Finally, upload the GitHub repo.
From now on, I can use markdown to quickly create a beautiful documentation page for my projects.
MkDocs is easy to use and simple to learn. Here are the commands needed to build my first documentation project.
$ mkdocs new .
$ mkdocs serve -a 0.0.0.0:8000
$ mkdocs build
Links#
- James blog post: Getting Started with Material for MkDocs
- Material for MkDocs
