Files
GitGuide/mkdocs.yml
2021-03-18 15:07:35 +08:00

45 lines
1.2 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 站点名称
site_name: 'GitGuide'
# 仓库链接
repo_url: https://github.com/ZJDoc/GitGuide.git
# 作者
site_author: 'zhujian'
# 版权信息
copyright: '2021, zhujian'
# 源文件目录
docs_dir: 'docs'
# 生成静态文件目录
site_dir: 'site'
# 额外信息
extra:
# 版本号
version: 0.1.0
# 主题
theme:
# name: 'readthedocs'
# name: 'mkdocs'
name: 'material'
# markdown扩展
markdown_extensions:
# 参考[MathJax](https://squidfunk.github.io/mkdocs-material/reference/mathjax/),支持数学公式渲染
- pymdownx.arithmatex:
generic: true
# 参考[Icons + Emojis](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/)执行Markdown Emoji
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
# mathjax
extra_javascript:
- javascripts/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# 导航
nav:
- Home: index.md
- 规范:
- README:
- 引言: readme/index.md
- '[译]规范': readme/译-规范.md
- '徽章': readme/badge.md