Skip to main content

smallzh's book theme for MkDocs

Project description

MkDocs Smzhbook Theme

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

0x00.使用

安装主题

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

0x01.开发

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

# 创建虚拟环境
uv venv .venv
# 安装 mkdocs
uv pip install mkdocs
# 启动
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.1.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.1-py2.py3-none-any.whl (1.0 MB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: mkdocs_smzhbook_theme-1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 2b6adcd8a0e5ac19c4fecd253eb0211505e2883951473dc18f6ff0066a397da7
MD5 40195bd767f5f54bc8866e4115707644
BLAKE2b-256 e784db44313ba056d1c528aa60037a7ac007fe810f42a6d82dc22867904d3d1e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_smzhbook_theme-1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 84f19993204276399da8a822791b770d23fc265c0a46bbf42b2d65fe8030f41d
MD5 d8579e52271c7790b3dd0a524893345b
BLAKE2b-256 f1506da2ffb1be10b1fcddb976e7216a419dd3acd0c955545233263ed1feb19a

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