site_name: Dokka documentation

# Meta tags (placed in header)
site_description: Dokka is an API documentation engine for Kotlin, performing the same function as the Javadoc tool for Java
site_author: JetBrains
site_url: https://github.com/Kotlin/dokka

# Repository (add link to repository on each page)
repo_name: dokka
repo_url: https://github.com/Kotlin/dokka
edit_uri: edit/master/docs/src/doc/docs/

# Copyright (shown at the footer)
copyright: 'Copyright © 2022 JetBrains'

# Material theme
theme:
  name: 'material'
  favicon: favicon.svg
  social:
    - type: 'github'
      link: 'https://github.com/Kotlin/dokka'
  features:
    - navigation.expand
    - navigation.tabs
    - navigation.instant
    - navigation.indexes
    - navigation.top

# Extensions
markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - footnotes
  - meta
  - def_list
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.smartsymbols
  - attr_list
  - md_in_html
  - pymdownx.superfences:
      custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format

# Dev server binding
#dev_addr: 127.0.0.1:3001

nav:
  - Home:
      - index.md
      - User guides: user_guide/introduction.md
      - Developer guides: developer_guide/introduction.md
      - Community: community/slack.md
      - FAQ: faq.md
  - User guides:
      - User guides: user_guide/introduction.md
      - Applying Dokka:
          - Gradle: user_guide/applying/gradle.md
          - Maven: user_guide/applying/maven.md
          - Command line: user_guide/applying/cli.md
      - Output formats:
          - HTML: user_guide/output-formats/html.md
      - Plugins:
          - Versioning plugin: user_guide/plugins/versioning-plugin.md
          - Android plugin: user_guide/plugins/android-plugin.md
  - Developer guides:
      - Developer guides: developer_guide/introduction.md
      - Workflow: developer_guide/workflow.md
      - Internals:
          - Architecture: developer_guide/architecture/architecture_overview.md
          - Data model:
              -  Documentables: developer_guide/architecture/data_model/documentables.md
              -  Page & Content: developer_guide/architecture/data_model/page_content.md
              -  Extra properties: developer_guide/architecture/data_model/extra.md
          - Extension points:
              - Extension points: developer_guide/architecture/extension_points/introduction.md
              - Core extension points: developer_guide/architecture/extension_points/core_extensions.md
              - Base extensions: developer_guide/architecture/extension_points/base_extensions.md
      - Plugin development:
          - Plugin development: developer_guide/plugin-development/introduction.md
          - Sample plugin tutorial: developer_guide/plugin-development/sample-plugin-tutorial.md
  - Community:
      - Slack: community/slack.md
      - Community plugins: community/plugins-list.md
  - FAQ: faq.md

extra_css:
  - dokka_colors.css
extra_javascript:
  - survey_banner.js