mkdocs/src/doc/mkdocs.yml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

site_name: Dokka

# 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/mkdocs/src/doc/docs/

# Copyright (shown at the footer)
copyright: 'Copyright &copy; 2023 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 for livereload
dev_addr: 127.0.0.1:3001

nav:
  - Home:
      - index.md
      - User guides: https://kotlinlang.org/docs/dokka-introduction.html
      - Developer guides: developer_guide/introduction.md
      - Community: community/slack.md
  - User guides:
      - https://kotlinlang.org/docs/dokka-introduction.html
  - 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

extra_css:
  - dokka_colors.css