MKDOCS的Ponylang材料主题
mkdocs-ponylang的Python项目详细描述
Ponylang mkdocs主题
基于https://github.com/squidfunk/mkdocs-material的自定义主题 Ponylang标准库文档的mkdocs。
用法
从pypi安装主题：
pip install mkdocs-ponylang
在mkdocs.yml文件中，更改主题：
theme:name:ponylang
定制
目录
# Enable permalinksmarkdown_extensions:-markdown.extensions.toc:permalink:true# Set maximum depththeme:max_toc_depth:2
调色板
theme:palette:primary:brownaccent:amber
您可以从列出的主色和强调色中选择here。
图标
theme:favicon:asserts/image/logo.pnglogo:icon:cloud
徽标可以是图像或材质图标（更多信息here）。
源代码库
repo_name:ponylang/ponycrepo_url:https://github.com/ponylang/ponyc
其他自定义设置
在Material theme documentation中提供了额外的自定义选项。
开发
要求
- Python3
- 净现值
- libpng dev
安装
这将设置本地安装主题所需的所有软件包。
git clone https://github.com/ponylang/mkdocs-theme cd mkdocs-theme python -m venv venv source venv/bin/activate pip install -e . npm install
建造
使用webpack从src/编译文件：
npm run build
分布
用绳线上传到pypi:
记住使用上面创建的virtualenv中的python。
rm dist/* python setup.py sdist bdist_wheel twine upload dist/*
欢迎加入QQ群-->： 979659372
