cnocr
/
mkdocs.yml

# Project information
site_name: CnOCR
site_url: https://cnocr.readthedocs.io
site_description: CnOCR 使用说明文档
site_author: Breezedeus

# Repository
repo_url: https://github.com/breezedeus/cnocr
repo_name: Breezedeus/CnOCR
edit_uri: "" #disables edit button

# Copyright
copyright: Copyright &copy; 2021 - 2022

# Social media
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/breezedeus
    - icon: fontawesome/brands/zhihu
      link: https://www.zhihu.com/people/breezedeus-50
    - icon: fontawesome/brands/youtube
      link: https://space.bilibili.com/509307267
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/breezedeus

# Configuration
theme:
  name: material
#  name: readthedocs
  logo: figs/breezedeus.png
  favicon: figs/breezedeus.ico
  palette:
    primary: indigo
    accent: indigo
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.tabs
    - navigation.expand
  icon:
    repo: fontawesome/brands/github

# Extensions
markdown_extensions:
  - meta
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - admonition # alerts
  - pymdownx.details #  collapsible alerts
  - pymdownx.superfences # nest code and content inside alerts
  - attr_list # add HTML and CSS to Markdown elements
  - md_in_html
  - pymdownx.inlinehilite # inline code highlights
  - pymdownx.keys # show keystroke symbols
  - pymdownx.snippets # insert content from other files
  - pymdownx.tabbed # content tabs
  - footnotes
  - def_list
  - pymdownx.arithmatex: # mathjax
      generic: true
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: false
  - codehilite
  - pymdownx.highlight:
      use_pygments: true
  - toc:
      toc_depth: 4

# Plugins
plugins:
  - search
  - macros
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_root_heading: false
            show_source: true
            show_category_heading: true
      watch:
        - cnocr

# Extra CSS
extra_css:
  - static/css/custom.css

# Extra JS
extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Page tree
nav:
  - 首页: index.md
  - 详细文档:
      - 🛠️ 安装: install.md
      - 📖 使用说明: usage.md
      - 🛀🏻 在线Demo: demo.md
      - 🏄🏻 ‍️命令行工具: command.md
      - 🤼‍️️ 分类模型工具: clf_command.md
      - 🧳 可用模型: models.md
      - 🕹 模型训练: train.md
      - 📡 OCR技术介绍: std_ocr.md
      - 💬 交流群: contact.md
      - 🥤 给作者加油: buymeacoffee.md
      - 🙋🏽 常见问题（FAQ）: faq.md
      - 🗒 RELEASE说明: RELEASE.md
  - 接口说明:
    - CnOcr 类: cnocr/cn_ocr.md
    - Recognizer 类: cnocr/recognizer.md
    - ppocr.PPRecognizer 类: cnocr/pp_recognizer.md