Skip to main content

MkDocs (Python)

·182 words·1 min
zd
Posts 101 documentation markdown python tools
Table of Contents
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 markdown files (.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#

Author
zd
cli-geek

Related

Generator Expression in Python
·567 words·3 mins
Posts 101 python
Python: List comprehension vs Generator expression.
Cloud Native Tools
·517 words·3 mins
Posts 101 cloud tools
What are CSPM, CWPP, and CIEM?
VulnCheck KEV Community
·330 words·2 mins
Posts kev python tools vulncheck threatmgmt vulnmgmt
Introducing the VulnCheck Known Exploited Vulnerabilities (KEV) catalog, a free community database of known exploited vulnerabilities fused with exploit intelligence.