mkdocs.yml

# The arkhe documentation. Everything is written in Markdown and nothing else.
#   - the text is .md under docs/. Japanese uses the same name with .ja inserted
#     (docs/index.ja.md)
#   - diagrams are Mermaid in a code block, with no step that exports an image
#   - the API specification is the openapi.json generated from the implementation,
#     so it is not written twice
site_name: arkhe
site_description: ARK identifier infrastructure — minter and resolver as separate services
site_url: https://rcosdp.github.io/arkhe/
repo_url: https://github.com/RCOSDP/arkhe
repo_name: RCOSDP/arkhe
edit_uri: edit/main/docs/
copyright: MIT — National Institute of Informatics

theme:
  name: material
  language: en
  icon:
    logo: material/key-chain
    repo: fontawesome/brands/github
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: deep purple
      toggle: {icon: material/weather-night, name: Switch to dark mode}
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle: {icon: material/weather-sunny, name: Switch to light mode}
  features:
    # navigation.instant does not work with the i18n language switcher; it warns
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer
    - toc.follow
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight

plugins:
  - search
  # Japanese and English. Inserting .ja into the same name pairs them, with no
  # separate directory tree.
  - i18n:
      docs_structure: suffix
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: ja
          name: 日本語
          build: true
          nav_translations:
            Introduction: はじめに
            Overview: arkhe とは
            Quickstart: クイックスタート
            Concepts: 考え方
            What ARK is: ARK とは何か
            Delegation: 委譲の構造
            Invariants: 壊さないもの
            Guides: 手引き
            Setting up for the first time: はじめて立ち上げるとき
            From minting to resolving, with curl: curl で採番から解決まで
            Authentication: 認証
            Admin interface: 管理画面
            Python client: Python クライアント
            Succession and departure: 承継と離脱
            Deployment: デプロイ
            Running several arkhe: 分散して運用する
            Reference: リファレンス
            Configuration: 設定
            CLI: コマンド
            Data model: データモデル
            API: API
            Errors: エラー
            Project: プロジェクト
            Contributing: 参加する
            How arkhe compares: ほかの実装との比較
            Versioning: バージョン
            Changelog: 変更履歴

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
      # The default slugify drops non-ASCII, so Japanese headings become anchors
      # like _1 and _2: deep links are impossible, and adding one heading shifts the
      # numbers so that existing links quietly point somewhere else.
      slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
  - pymdownx.details
  # The :material-...: icons are converted by the emoji extension. Without it, the
  # cards on the landing page show the literal string :material-api:. Nothing warns:
  # an unknown shorthand passes through as text, so --strict does not catch it, and it
  # was published that way for a while.
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight: {anchor_linenums: true}
  - pymdownx.inlinehilite
  # Pull the changelog at the repository root into the documentation, rather than
  # keeping a second copy
  - pymdownx.snippets: {base_path: ['.', 'docs']}
  - pymdownx.tabbed: {alternate_style: true}
  # Let Mermaid be written inline, with no step that exports an image
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  alternate:
    - name: English
      link: /arkhe/
      lang: en
    - name: 日本語
      link: /arkhe/ja/
      lang: ja
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/RCOSDP/arkhe

extra_css: [assets/extra.css]

nav:
  - Introduction:
      - Overview: index.md
      - Quickstart: quickstart.md
  - Concepts:
      - What ARK is: concepts/ark.md
      - Delegation: concepts/delegation.md
      - Invariants: concepts/invariants.md
  - Guides:
      - Setting up for the first time: guides/onboarding.md
      - From minting to resolving, with curl: guides/walkthrough.md
      - Authentication: guides/authentication.md
      - Admin interface: guides/admin.md
      - Python client: guides/python-client.md
      - Succession and departure: guides/succession.md
      - Deployment: guides/deployment.md
      - Running several arkhe: guides/federation.md
  - Reference:
      - Configuration: reference/configuration.md
      - CLI: reference/cli.md
      - Data model: reference/data-model.md
      - API: reference/api.md
      - Errors: reference/errors.md
  - Project:
      - Contributing: project/contributing.md
      - How arkhe compares: project/comparison.md
      - Versioning: project/versioning.md
      - Changelog: project/changelog.md