跳转至

mkdoc使用说明

选项卡

折叠的写法

折叠

mkdoc使用说明的目录
[TOC]
语法 
1
2
3
4
<details markdown="1">
<summary>Linux环境</summary>   
[TOC]   
</details>

折叠

折叠@@

1
2
??? 折叠
    折叠@@
折叠

折叠@@

1
2
???+ 折叠
    折叠@@

选项卡支持的图标

note 、info、abstract、tip、success、question、warning、failure、danger、bug、example、quote

mkdocs 临时调试

1
docker run -id --rm -p 11223:80 -v $PWD:/home/ admibo/mkdocs

配置Markdown设置目录、并折叠

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
1、其中[toc]是生成目录的语法
2、details包含的内容是折叠markdown
3、在mkdocs配置文件中添加下面内容
markdown_extensions:
 - toc
 - md_in_html
4、在details 中添加 markdown="1"

block = 强行解析；全部解析
1     = 默认解析
span  = 强行解析；元素的内容不会解析为块级内容。换句话说，内容不会 呈现为段落、标题等。只会呈现内联语法，例如链接、强语法、强调语法等
参考

自定义字体

配置 mkdoc.yml 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
theme:
  name: material

  font:
    text: LXGW WenKai Screen
    code: LXGW WenKai Screen

extra_css:
  - https://cdn.bootcdn.net/ajax/libs/lxgw-wenkai-screen-webfont/1.7.0/style.min.css

# 下方是其他网站使用的css , 可以不加  
body {
    font-family: "LXGW WenKai Screen", sans-serif;
}

主题material

配置说明

源码 https://github.com/squidfunk/mkdocs-material.git 

 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
├─ .icons/                             # 打包的图标集
├─ assets/
│  ├─ images/                          # 图片和图标
│  ├─ javascripts/                     # JavaScript 文件
│  └─ stylesheets/                     # 样式表
├─ partials/
│  ├─ integrations/                    # 第三方集成
│  │  ├─ analytics/                    # 分析集成
│  │  └─ analytics.html                # 分析设置
│  ├─ languages/                       # 翻译语言
│  ├─ actions.html                     # 操作
│  ├─ alternate.html                   # 网站语言选择器
│  ├─ comments.html                    # 评论系统（默认为空）
│  ├─ consent.html                     # 同意
│  ├─ content.html                     # 页面内容
│  ├─ copyright.html                   # 版权和主题信息
│  ├─ feedback.html                    # 此页面是否有帮助？
│  ├─ footer.html                      # 底部栏
│  ├─ header.html                      # 顶部栏
│  ├─ icons.html                       # 自定义图标
│  ├─ language.html                    # 翻译设置
│  ├─ logo.html                        # 顶部和侧边栏的徽标
│  ├─ nav.html                         # 主导航
│  ├─ nav-item.html                    # 主导航项
│  ├─ pagination.html                  # 分页（用于博客）
│  ├─ palette.html                     # 调色板切换
│  ├─ post.html                        # 博客文章摘要
│  ├─ progress.html                    # 进度指示器
│  ├─ search.html                      # 搜索界面
│  ├─ social.html                      # 社交链接
│  ├─ source.html                      # 存储库信息
│  ├─ source-file.html                 # 源文件信息
│  ├─ tabs.html                        # 选项卡导航
│  ├─ tabs-item.html                   # 选项卡导航项
│  ├─ tags.html                        # 标签
│  ├─ toc.html                         # 目录
│  ├─ toc-item.html                    # 目录项
│  └─ top.html                         # 返回顶部按钮
├─ 404.html                            # 404错误页面
├─ base.html                           # 基础模板
├─ blog.html                           # 博客索引页面
├─ blog-archive.html                   # 博客存档索引页面
├─ blog-category.html                  # 博客分类索引页面
├─ blog-post.html                      # 博客文章页面
└─ main.html                           # 默认页面