mkdocs.yml

# Project information
site_name: Next-gen Kaldi
site_url: https://k2-fsa.org
docs_dir: 'docs'
site_dir: 'site' 
site_author: Next-gen Kaldi team
site_description: >-
  Next-gen Kaldi

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

# Copyright
copyright: Copyright © 2019 - 2024 Next-gen Kaldi team

theme:
  name: material
  logo: assets/pic/k2.png
  favicon: assets/pic/k2.png
  language: en
  custom_dir: custom
  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:
  - search
  - blog
  - 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:
  - Home: index.md
  - Get started:
    - 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: models/asr.md
    - TTS: models/tts.md
    - KWS: models/kws.md
  - Demos:
    - ASR: demos/asr.md
    - TTS: demos/tts.md
    - KWS: demos/kws.md
  - Events: events.md
  - Publications: publications.md
  - Resources: resources.md
  - Blog:
    - blog/index.md
  - Message board: message.md

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - 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.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - 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