mkdocs.yml

# 站点名称
site_name: 'ZCls'
# 仓库链接
repo_url: https://github.com/ZJCV/ZCls.git
# 作者
site_author: 'zhujian'
# 版权信息
copyright: '2021, zhujian'
# 源文件目录
docs_dir: 'docs'
# 生成静态文件目录
site_dir: 'site'
# 额外信息
extra:
    # 版本号
    version: 0.15.2
# 主题
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
    - Roadmap: roadmap.md
    - Installation: install.md
    - Get Started with ZCls: get-started.md
    - Use Pretrained model: pretrained-model.md
    - Dataset:
      - Use Builtin Datasets: builtin-datasets.md
      - Use Custom Datasets:
        - GeneralDataset: ./general_dataset.md
        - LMDBDataset: ./lmdb_dataset.md
        - MPDataset: ./mp_dataset.md
    - Trick:
      - Data: trick-data.md
      - Train: trick-train.md
    - Benchmark:
      - ResNet/ResNeXt: benchmark-resnet.md
      - SENet/SKNet/ResNeSt: benchmark-resnest.md
      - MobileNet: benchmark-mobilenet.md
      - ShuffleNet: benchmark-shufflenet.md
      - RepVGG: benchmark-repvgg.md
      - GhostNet: benchmark-ghostnet.md