Skip to main content

smallzh's book theme for MkDocs

Project description

MkDocs Smzhbook Theme

blog.smallzh.top网站使用的主题,基于MkDocs 构建。

0x01.使用

安装主题

pip install mkdocs-smzhbook-theme

配置 MkDocs

mkdocs.yml 中设置主题:

site_name: Your Site Name
theme:
  name: smzhbook

自定义样式和脚本

extra_css:
  - custom.css

extra_javascript:
  - custom.js

本地开发主题

如果需要在本地直接使用主题源码(而非安装的包),可以在 mkdocs.yml 中直接指定主题目录:

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

0x02.开发

先安装 uv ,再执行以下命令

# 创建虚拟环境
uv sync
# 启动
uv run mkdocs serve

0xFF.感谢

  1. MkDocs ,简单易用的静态站点生成器
  2. mkdocs-basic-theme , mkdocs的基础主题库

PyPI Downloads PyPI Version

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_smzhbook_theme-1.2.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_smzhbook_theme-1.2-py2.py3-none-any.whl (1.0 MB view details)

Uploaded Python 2Python 3

File details

Details for the file mkdocs_smzhbook_theme-1.2.tar.gz.

File metadata

  • Download URL: mkdocs_smzhbook_theme-1.2.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.6

File hashes

Hashes for mkdocs_smzhbook_theme-1.2.tar.gz
Algorithm Hash digest
SHA256 c070575fae8e69f31c8446c11315b846c7d8877bbab411d1b00a298429ed42be
MD5 cbef5b366008e9bc51e0f8ffc1a14195
BLAKE2b-256 07380a757552d416196fe776234edeb11d75fefd0d54b56385a5109cee528aac

See more details on using hashes here.

File details

Details for the file mkdocs_smzhbook_theme-1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_smzhbook_theme-1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e712d06aa1261ee3c39c23e9fb891475a0540da3b746f0c2ce58fbe67623dd52
MD5 f0bfe929b221eca3dcbf4ab2390e3d6c
BLAKE2b-256 9cad9c037564e976b8303c21577662773c075f9d02e0913fdaf9474ad3044b01

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page