知识库编写指引

1.知识库采用mkdocs-material作为文档框架，整体使用docker部署，运行在NAS上。

2.文档存放的位置：/wiki/docs，对于一个新的兵种/技术方向，应该在docs下新建对应文件夹，如sentry或hero。文档有更新时使用覆盖上传即可。

3.编辑wiki/mkdocs.yml即可使文档在导航栏中可见，示例：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
site_name: PFA KnowledgeBase
site_description: 厦门理工PFA战队内建知识库

nav:
  - Home: general/index.md
  - 2024赛季兵种代码讲解: 
      - 哨兵: sentry2024/tutorial.md
      # 冒号前的文字会被显示在导航栏中，冒号后则是文档存放位置相对docs的路径
      # 如哨兵文档的绝对路径为/volume1/wiki/docs/sentry2024/tutorial.md，则直接填写sentry2024/tutorial.md即可
      # 如果一行描述被缩进，则导航栏中相应的文字会被折叠（手动点击后展开）

# 以下代码用于配置markdown扩展功能，无需关心
markdown_extensions:
  - admonition
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

目前已经支持的扩展功能：数学公式（使用MathJax），提示框

4.所有文档使用markdown格式