diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-02-20 19:15:42 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-20 19:15:42 +0100 |
| commit | 57622719edb912d7c3320f7e59cd6928e5c25e44 (patch) | |
| tree | e00db16dc54ce11b025cdb1bc8cf204bd6efebe3 /mkdocs/src/doc/docs/developer_guide | |
| parent | 1e10c6f47d605e1e730cb58aa44f3051ec5a493b (diff) | |
| download | dokka-57622719edb912d7c3320f7e59cd6928e5c25e44.tar.gz dokka-57622719edb912d7c3320f7e59cd6928e5c25e44.tar.bz2 dokka-57622719edb912d7c3320f7e59cd6928e5c25e44.zip | |
Exclude user guides from mkdocs documentation (#2868)
Diffstat (limited to 'mkdocs/src/doc/docs/developer_guide')
| -rw-r--r-- | mkdocs/src/doc/docs/developer_guide/architecture/extension_points/core_extensions.md | 2 | ||||
| -rw-r--r-- | mkdocs/src/doc/docs/developer_guide/plugin-development/introduction.md | 11 |
2 files changed, 11 insertions, 2 deletions
diff --git a/mkdocs/src/doc/docs/developer_guide/architecture/extension_points/core_extensions.md b/mkdocs/src/doc/docs/developer_guide/architecture/extension_points/core_extensions.md index 381a9596..77ebc15e 100644 --- a/mkdocs/src/doc/docs/developer_guide/architecture/extension_points/core_extensions.md +++ b/mkdocs/src/doc/docs/developer_guide/architecture/extension_points/core_extensions.md @@ -147,5 +147,5 @@ and `CommonmarkRenderer`. `PostAction` is useful for when you want to run some actions after the documentation has been generated - for instance if you want to move some files around. -[Versioning plugin](../../../user_guide/plugins/versioning-plugin.md) utilizes `PostAction` in order to move +[Versioning plugin](https://github.com/Kotlin/dokka/tree/master/plugins/versioning) utilizes `PostAction` in order to move generated documentation to versioned folders. diff --git a/mkdocs/src/doc/docs/developer_guide/plugin-development/introduction.md b/mkdocs/src/doc/docs/developer_guide/plugin-development/introduction.md index fbfb32ac..6a487a5e 100644 --- a/mkdocs/src/doc/docs/developer_guide/plugin-development/introduction.md +++ b/mkdocs/src/doc/docs/developer_guide/plugin-development/introduction.md @@ -1,5 +1,13 @@ # Introduction to plugin development +Dokka was built from the ground up to be easily extensible and highly customizable, which allows the community to +implement plugins for missing or very specific features that are not provided out of the box. + +Dokka plugins range anywhere from supporting other programming language sources to exotic output formats. You can add +support for your own KDoc tags or annotations, teach Dokka how to render different DSLs that are found in KDoc +descriptions, visually redesign Dokka's pages to be seamlessly integrated into your company's website, integrate +it with other tools and so much more. + In order to have an easier time developing plugins, it's a good idea to go through [Dokka's internals](../architecture/architecture_overview.md) first to learn more about its [data model](../architecture/data_model/documentables.md) and @@ -51,7 +59,8 @@ versions of Dokka. You can follow the [sample plugin tutorial](sample-plugin-tutorial.md) which covers creation of a simple plugin: hide members annotated with your own `@Internal` annotation, that is exclude these members from generated documentation. -Fore more practical examples, have a look at sources of [community plugins](../../community/plugins-list.md). +Fore more practical examples, have a look at sources of +[community plugins](https://kotlinlang.org/docs/dokka-plugins.html#notable-plugins). ## Help |