docs/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

site_name: Dokka

# Meta tags (placed in header)
site_description: Dokka is a documentation engine for Kotlin, performing the same function as javadoc 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/src/doc/docs/

# Copyright (shown at the footer)
copyright: 'Copyright &copy; 2020 Jetbrains'

# Material theme
theme:
  name: 'material'
  favicon: favicon.svg
  social:
    - type: 'github'
      link: 'https://github.com/Kotlin/dokka'

# 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
  - pymdownx.superfences

# Dev server binding
#dev_addr: 127.0.0.1:3001

nav:
  - Home: index.md
  - User guide:
      - Introduction: user_guide/introduction.md
      - Gradle: user_guide/gradle/usage.md
      - Maven: user_guide/maven/usage.md
      - Command line: user_guide/cli/usage.md
  - Plugin development:
      - Introduction: developer_guide/introduction.md
      - Data model: developer_guide/data_model.md
      - Extension points: developer_guide/extension_points.md
  - Community:
      - Community plugins: community/plugins-list.md
  - About:
      - FAQ: about/FAQ.md
      - Slack channel: about/slack_channel.md

extra_javascript:
  - expand_navigation.js

extra_css:
  - dokka_colors.css