mkdocs-smzhbook-theme 1.3

smallzh's book theme for MkDocs

MkDocs Smzhbook Theme

The theme used on the blog.smallzh.top website, built with MkDocs.

English | Chinese

0x01.Usage

Installing the Theme

pip install mkdocs-smzhbook-theme

Configuring MkDocs

Setting the theme in mkdocs.yml:

site_name: Your Site Name
theme:
  name: smzhbook

Customizing Styles and Scripts

extra_css:
  - custom.css

extra_javascript:
  - custom.js

Local Theme Development

If you need to use the theme source code directly locally (rather than the installed package), you can specify the theme directory directly in mkdocs.yml:

theme:
  name: null
  dir: /path/to/mkdocs-smzhbook-theme/smzhbook_theme

0x02.Development

First install uv, then run the following commands

# Create virtual environment
uv sync
# Start
uv run mkdocs serve

0xFF.Acknowledgments

1. MkDocs - A simple and easy-to-use static site generator
2. mkdocs-basic-theme - MkDocs' base theme library