diff options
Diffstat (limited to 'docs/src/doc/mkdocs.yml')
-rw-r--r-- | docs/src/doc/mkdocs.yml | 76 |
1 files changed, 52 insertions, 24 deletions
diff --git a/docs/src/doc/mkdocs.yml b/docs/src/doc/mkdocs.yml index 139c2297..d8aba618 100644 --- a/docs/src/doc/mkdocs.yml +++ b/docs/src/doc/mkdocs.yml @@ -1,8 +1,8 @@ -site_name: Dokka +site_name: Dokka documentation # 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_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) @@ -11,7 +11,7 @@ repo_url: https://github.com/Kotlin/dokka edit_uri: edit/master/docs/src/doc/docs/ # Copyright (shown at the footer) -copyright: 'Copyright © 2020 Jetbrains' +copyright: 'Copyright © 2022 JetBrains' # Material theme theme: @@ -20,6 +20,12 @@ theme: social: - type: 'github' link: 'https://github.com/Kotlin/dokka' + features: + - navigation.expand + - navigation.tabs + - navigation.instant + - navigation.indexes + - navigation.top # Extensions markdown_extensions: @@ -37,33 +43,55 @@ markdown_extensions: - pymdownx.inlinehilite - pymdownx.magiclink - pymdownx.smartsymbols - - pymdownx.superfences + - 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 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 - - Html frontend: user_guide/base-specific/frontend.md - - Versioning: user_guide/versioning/versioning.md - - Android plugin: user_guide/android-plugin/android-plugin.md - - Plugin development: - - Introduction: developer_guide/introduction.md - - Data model: developer_guide/data_model.md - - Extension points: developer_guide/extension_points.md + - 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 - - About: - - FAQ: about/FAQ.md - - Slack channel: about/slack_channel.md - -extra_javascript: - - expand_navigation.js + - FAQ: faq.md extra_css: - dokka_colors.css |