mkdocs.yml

site_name: RapidOCR 文档
site_url: https://rapidai.github.io/RapidOCRDocs/
site_author: RapidAI
site_description:
  RapidOCR 是支持离线部署的开源 OCR 工具，面向 Python、C++、Java、C# 等生态，支持 ONNX Runtime、OpenVINO、Paddle、PyTorch、MNN、TensorRT 等推理引擎。

repo_name: RapidAI/RapidOCR
repo_url: https://github.com/RapidAI/RapidOCR

copyright: Copyright © 2025 Maintained by SWHL.

edit_uri: https://github.com/RapidAI/RapidOCRDocs/blob/main/docs

theme:
  name: material
  # logo: /static/images/favicon-lightning.svg
  favicon: ./static/images/favicon-lightning.svg
  language: zh
  custom_dir: overrides
  features:
    - announce.dismiss
    - content.tooltips
    - content.code.copy
    - content.tabs.link
    - content.action.edit  # 显示编辑按钮
    - content.action.view  # 显示查看源码按钮
    - content.footnote.tooltips
    - navigation.expand  # 默认打开所有的子节
    - navigation.tabs # 顶级索引被作为tab
    - navigation.tabs.sticky # tab始终可见
    - navigation.top # 开启顶部导航栏
    - navigation.tracking # 导航栏跟踪
    - navigation.footer
    - navigation.indexes
    - search.highlight # 搜索高亮
    - search.share # 搜索分享
    - search.suggest # 搜索建议
    - toc.follow # 目录跟踪-页面右侧的小目录

  palette:
    - media: "(prefers-color-scheme)" # 系统主题
      toggle:
        icon: material/theme-light-dark
        name: 系统主题
    - media: "(prefers-color-scheme: light)" # 亮色主题
      scheme: default
      primary: white
      accent: light blue
      toggle:
        icon: material/weather-sunny
        name: 明亮主题
    - media: "(prefers-color-scheme: dark)" # 暗色主题
      scheme: slate
      primary: black
      accent: yellow
      toggle:
        icon: material/weather-night
        name: 暗黑主题

  icon:
    logo: fontawesome/solid/bolt
    previous: fontawesome/solid/angle-left
    next: fontawesome/solid/angle-right
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
    tag:
      default-tag: fontawesome/solid/tag
      hardware-tag: fontawesome/solid/microchip
      software-tag: fontawesome/solid/laptop-code

plugins:
  - meta
  - rss:
      match_path: "blog/posts/.*"
      date_from_meta:
        as_creation: date.created
        as_update: "git"
      length: 20
      pretty_print: true
  - blog:
      blog_dir: blog
      archive: true
      archive_name: Archive
      archive_date_format: yyyy/MM
      archive_url_format: "archive/{date}"
      post_date_format: short
      blog_toc: true
      pagination: false
      categories_toc: true
      categories_name: Categories
  - tags
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - git-committers:
      repository: RapidAI/RapidOCRDocs
      branch: main
      token: !!python/object/apply:os.getenv ["BLOG_MKDOCS_GIT_COMMITTERS_APIKEY"]
  - git-revision-date-localized:
      enable_creation_date: true
      timezone: Asia/Shanghai
      type: iso_datetime
      exclude:
        - "index.md"
        - "business_support.md"
        - "communicate.md"
        - "quickstart.md"
        - "online_demo.md"
        - "related_projects.md"
        - "model_list.md"
        - "sponsor.md"
        - "install_usage/**"

hooks:
  - hooks/announce.py
  - hooks/expiry.py
  - hooks/change_copyright.py
  - hooks/link.py
  - hooks/markdown_export.py

extra_css:
  - stylesheets/extra.css
  - https://cdn.jsdelivr.net/npm/lxgw-wenkai-screen-web/style.css

extra_javascript:
  - javascripts/extra.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/RapidAI
    - icon: fontawesome/brands/weixin
      link: https://raw.githubusercontent.com/RapidAI/.github/main/assets/RapidAI_poster_compose.png
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/rapidocr/
    - icon: fontawesome/solid/rss
      link: https://rapidai.github.io/RapidOCRDocs/main/feed_rss_created.xml
  version:
    provider: mike
  expiry_days: 180
  link_pages:
    - changelog/*.md
    - faq/*.md

markdown_extensions:
  - abbr
  - attr_list
  - pymdownx.snippets
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.details
  - footnotes
  - def_list
  - md_in_html
  - tables
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
        anchor_linenums: true
        line_spans: __span
        pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - admonition

not_in_nav: |
  /tags.md

nav:
  - 概览: index.md
  - 快速开始: quickstart.md
  - 在线 demo: online_demo.md
  - 模型列表: model_list.md
  - 安装及使用:
    - rapidocr:
      - 安装: install_usage/rapidocr/install.md
      - 使用: install_usage/rapidocr/usage.md
      - 参数介绍: install_usage/rapidocr/parameters.md
      - 打包:
        - 如何自行构建指定版本的 rapidocr whl 包: install_usage/rapidocr/package/build-custom-version-rapidocr-whl.md
      - 使用不同推理引擎: install_usage/rapidocr/how_to_use_infer_engine.md
      - 使用本地模型推理: install_usage/rapidocr/how_to_use_offline_model.md
      - 使用 PP-OCRv5 模型: install_usage/rapidocr/how_to_use_ppocrv5.md
      - 导出为 markdown 格式: install_usage/rapidocr/how_to_convert_to_markdown.md
    - rapidocr_web:
      - 安装及使用: install_usage/rapidocr_web/usage.md
      - 桌面版使用教程: install_usage/rapidocr_web/desktop_usage.md
      - Nuitka 打包: install_usage/rapidocr_web/nuitka_package.md
      - PyInstaller 打包: install_usage/rapidocr_web/pyinstaller.md
      - 多语言版本部署: install_usage/rapidocr_web/ocrweb_multi.md
      - 更新日志: install_usage/rapidocr_web/changelog.md
    - rapidocr_api:
      - 安装及使用: install_usage/rapidocr_api/usage.md
      - 更新日志: install_usage/rapidocr_api/changelog.md
  - 更新日志:
    - v3.9.2: changelog/v3.9.2.md
    - v3.9.1: changelog/v3.9.1.md
    - v3.9.0: changelog/v3.9.0.md
    - v3.8.4: changelog/v3.8.4.md
    - v3.8.3: changelog/v3.8.3.md
    - v3.8.2: changelog/v3.8.2.md
    - v3.8.1: changelog/v3.8.1.md
    - v3.8.0: changelog/v3.8.0.md
    - v3.7.0: changelog/v3.7.0.md
    - v3.6.0: changelog/v3.6.0.md
    - v3.5.0: changelog/v3.5.0.md
    - v3.4.5: changelog/v3.4.5.md
    - v3.4.3: changelog/v3.4.3.md
    - v3.4.2: changelog/v3.4.2.md
    - v3.4.1: changelog/v3.4.1.md
    - v3.4.0: changelog/v3.4.0.md
  - 贡献指南: contributing.md
  # - AI 知识库: ai.md
  - 常见问题: faq/faq.md
  - 周边项目: related_projects.md
  - 博客:
    - blog/index.md
  - 交流群: communicate.md
  - 赞助: sponsor.md
  - 商业支持: business_support.md