mkdocs-github-readthedocs/mkdocs.yml at master · Document-Collection/mkdocs-github-readthedocs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# 站点名称
site_name: 'MkDocs-Github-Readthedocs'
# 仓库链接
repo_url: https://github.com/zjZSTU/mkdocs-github-readthedocs.git
# 作者
site_author: 'zhujian'
# 版权信息
copyright: '2019, zhujian'
# 源文件目录
docs_dir: 'docs'
# 生成静态文件目录
site_dir: 'site'
# 额外信息
extra:
    # 版本号
    version: 1.0.0
# 主题
theme:
    # name: 'readthedocs'
    # name: 'mkdocs'
    name: 'material'
# markdown扩展
markdown_extensions:
    - toc:
        permalink: true
    - pymdownx.arithmatex

extra_javascript:
    - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
# 导航
nav:
    - Home: index.md
    - Markdown:
        - '引言': './markdown/Markdown使用-1-引言.md'
        - '页内跳转': './markdown/Markdown使用-2-页内跳转.md'
        - '[CSDN]去除水印': './markdown/[CSDN]去除水印.md'
        - '表格': './markdown/Markdown使用-4-表格.md'
        - '数学公式': './markdown/Markdown使用-5-数学公式.md'
        - '截图公式转换': './markdown/Markdown使用-6-截图公式转换.md'
        - 'VSCode+Chrome': './markdown/Markdown使用-7-VSCode+Chrome.md'
        - '代码块设置': './markdown/Markdown使用-8-代码块设置.md'
        - '标签页实现': './markdown/Markdown使用-9-标签页实现.md'
        - '自定义Markdown编辑器': './markdown/Markdown使用-todo-自定义Markdown编辑器.md'

    - MkDocs:
        - 介绍: './mkdocs/引言.md'
        - Get-Started: './mkdocs/get-started.md'
        - 配置文件解析: './mkdocs/配置文件解析.md'
    - Readthedocs:
            - 介绍: './readthedocs/ReadtheDocs - 介绍.md'
            - 在线发布: './readthedocs/ReadtheDocs - 在线发布.md'
            - 徽章: './readthedocs/ReadtheDocs - 添加徽章.md'
            - 编译问题: './readthedocs/ReadtheDocs - 编译问题.md'
    - reStructuredText:
        - 常用语法: 'reStructuredText/reStructuredText-常用语法.md'
        - 目录树: 'reStructuredText/Sphinx-目录树.md'
    - Sphinx:
        - 介绍: 'sphinx/Sphinx - 介绍.md'
        - 新建文档工程: 'sphinx/Sphinx - 新建文档工程.md'
        - html主题: 'sphinx/Sphinx - html主题.md'
        - markdown配置: 'sphinx/Sphinx - Markdown.md'
        - MathJax配置: './sphinx/Sphinx - MathJax.md'
        - bug: 'sphinx/Sphinx - bug.md'
    - Pandoc: 'pandoc-文档转换工具.md'