docs/mkdocs.yml - develop - ivan_kirpichnikov/retejo

docs/mkdocs.yml
103 строки3 KB
ivankirpichnikov
feature: #8 add docs
26 июн 2025, 06:18
26 июн 2025, 06:1819e3f3d
site_name: Retejo
site_description: Retejo python web client documentation

repo_url: https://github.com/IvanKirpichnikov/retejo
repo_name: IvanKirpichnikov/retejo

docs_dir: docs

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil-circle-outline
  features:
    - search.suggest
    - search.highlight
    - navigation.tabs            # navbar navigation
    - navigation.tabs.sticky     # navbar always expanded
    - navigation.indexes         # attach index document direct to section
    - navigation.tracking        # show current TOC section in the page url
    - navigation.prune           # reduce render size
    - navigation.top             # back-to-top btn
    - navigation.footer          # show footer with next/prev btns
    # - navigation.path            # (insiders) breadcrumbs
    - content.tabs.link          # sync total page tabs
    # - content.tooltips           # (insiders) improved tooltips
    - content.code.copy
    - content.code.annotate      # code annotations with # (1)
    # - content.code.select        # (insiders) highlight line under cursor
    - content.action.edit        # add edit btn at every page
  palette:
    - sheme: default
      primary: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - i18n:
      docs_structure: folder
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: ru
          default: true
          name: Русский
          build: true
          nav:
            - Retejo: ru/index.md
            - Туториал:
              - Туториал: ru/tutorial/index.md
              - Метод: ru/tutorial/method.md
              - Клиент: ru/tutorial/client.md
              - Маркеры: ru/tutorial/markers.md
            - Интеграции:
              - Интеграции: ru/integrations/index.md
              - aiohttp: ru/integrations/aiohttp.md
              - requests: ru/integrations/requests.md
              - httpx: ru/integrations/httpx.md
              - adaptix: ru/integrations/adaptix.md
              - pydantic: ru/integrations/pydantic.md
            - Внести вклад: ru/contribution.md


        - locale: en
          default: false
          name: English
          build: true

markdown_extensions:
  - toc:
      permalink: "#"             # replace TOC block symbol
      toc_depth: 4
  - mdx_include:
      base_path: .
      line_slice_separator: []
  - extra
  - admonition                   # !!! note blocks support
  - pymdownx.details             # admonition collapsible
  - pymdownx.superfences         # highlight code syntax
  - pymdownx.highlight:
      anchor_linenums: true      # allows link to codeline
  - pymdownx.inlinehilite        # inline code highlighting `#!python <code>`
  - pymdownx.tabbed:
      alternate_style: true      # create tabs group
  - attr_list                    # specify html attrs in markdown
  - md_in_html                   # render md wrapped to html tags

extra:
  alternate:
    - name: Russian
      lang: ru
      link: /ru/

    - name: English
      lang: en
      link: /en/