mkdocs-zh-CN.yml

# Project information
site_name: 新一代 Kaldi
site_url: https://k2-fsa.org/zh-CN
docs_dir: 'docs-zh-CN'
site_dir: 'site/zh-CN' 
site_author: 新一代 Kaldi 团队
site_description: >-
  新一代 Kaldi

# Repository
repo_name: https://github.com/k2-fsa
repo_url: https://github.com/k2-fsa

# Copyright
copyright: Copyright © 2019 - 2024 新一代 Kaldi 团队

theme:
  name: material
  custom_dir: custom
  logo: assets/pic/k2.png
  favicon: assets/pic/k2.png
  language: zh
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.indexes
    - navigation.sections
    - navigation.expand
    - navigation.footer
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  palette:
    primary: custom
    scheme: k2

  font:
    text: Roboto
    code: Roboto Mono

plugins:
  - blog
  - search:
      separator: '[\s\u200b\-]'
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
          remove_comments: true
  - mkdocs-jupyter:
      include_source: True
      include_requirejs: true
  - git-committers:
      repository: pkufool/k2-fsa-www
      branch: main_page
  - git-revision-date-localized:
      enable_creation_date: true
      type: date

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

extra_css:
  - assets/stylesheets/extra.css

nav:
  - 主页: index.md
  - 从这开始:
    - get-started/index.md
    - k2: get-started/k2.md
    - Icefall: get-started/icefall.md
    - Lhotse: get-started/lhotse.md
    - Sherpa:
      - get-started/sherpa/index.md
      - Sherpa-torch: get-started/sherpa/torch.md
      - Sherpa-ncnn: get-started/sherpa/ncnn.md
      - Sherpa-onnx: get-started/sherpa/onnx.md
  - 模型:
    - 语音识别: models/asr.md
    - 语音合成: models/tts.md
    - 自定义唤醒: models/kws.md
  - 演示:
    - 语音识别: demos/asr.md
    - 语音合成: demos/tts.md
    - 自定义唤醒: demos/kws.md
  - 事件: events.md
  - 论文: publications.md
  - 资源: resources.md
  - 博客:
    - blog/index.md
  - 留言板: message.md

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde


# Customization
extra:
  alternate:  
    - name: English
      link: /
      lang: en
    - name: 中文
      link: /zh-CN/
      lang: zh

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/k2-fsa
    - icon: fontawesome/brands/weixin
      link: https://k2-fsa.org/assets/pic/wechat_account.jpg
    - icon: fontawesome/brands/weixin
      link: https://k2-fsa.org/assets/pic/wechat_group.jpg
    - icon: fontawesome/brands/qq
      link: https://k2-fsa.org/assets/pic/qq_group.jpeg
    - icon: fontawesome/brands/zhihu
      link: https://www.zhihu.com/people/yaozengwei
    - icon: fontawesome/brands/bilibili
      link: https://space.bilibili.com/1234519871