Skip to content

Commit a88982a

Browse files
committed
feat(doc): 新建mkdocs文档工程
1 parent e40726b commit a88982a

File tree

3 files changed

+40
-0
lines changed

3 files changed

+40
-0
lines changed

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# SSD
2+
3+
实现`SSD`目标检测算法

mkdocs.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# 站点名称
2+
site_name: 'SSD'
3+
# 仓库链接
4+
repo_url: https://github.com/zjZSTU/SSD.git
5+
# 作者
6+
site_author: 'zhujian'
7+
# 版权信息
8+
copyright: '2020, zhujian'
9+
# 源文件目录
10+
docs_dir: 'docs'
11+
# 生成静态文件目录
12+
site_dir: 'site'
13+
# 额外信息
14+
extra:
15+
# 版本号
16+
version: 0.1.0
17+
# 主题
18+
theme:
19+
# name: 'readthedocs'
20+
# name: 'mkdocs'
21+
name: 'material'
22+
# markdown扩展
23+
markdown_extensions:
24+
- toc:
25+
permalink: true
26+
- pymdownx.arithmatex
27+
28+
extra_javascript:
29+
- 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
30+
# 导航
31+
nav:
32+
- Home: index.md

requirements.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
mkdocs==1.0.4
2+
mkdocs-material==4.6.0
3+
mkdocs-minify-plugin==0.2.1
4+
Markdown==3.1.1
5+
markdown-katex==201912.11b0

0 commit comments

Comments
 (0)