{"repo":"Kotlin/dokka-plugin-template","free":true,"listed":false,"github":"https://github.com/Kotlin/dokka-plugin-template","clone":"git clone https://github.com/Kotlin/dokka-plugin-template.git","description":"Dokka plugin quickstart template with pre-configured dependencies and publishing","language":"Kotlin","stars":13,"topics":["dokka","kotlin","documentation","plugins","template"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"Dokka plugin template This repository provides a template for creating Dokka plugins (check the Creating a repository from a template article). TL;DR: Click the Use this template button and clone it in IntelliJ IDEA. Getting started Before writing a plugin it might be beneficial to spend 5 minutes reading our developer guide to have a basic idea about the data model and system architecture. If some you miss some information or something is unclear please let us know on community slack or via github issue. Structure A minimal repository for a Dokka plugin should contain files in the following structure: Applying the plugin In order to apply a plugin it needs to be published to a repository. For development use we recommend the mavenLocal. This repository contains a basic setup for publishing artefacts to that repository. In order to do it use publishToMavenLocal task. After that you will need a sample project to test on. Kotlin has a lot of sample projects to choose from eg: dokka-gradle-example In order to apply the plugin you need to add it to project dependencies: Please keep in mind, that you need to have a mavenLocal() repository in your project. After that you can run Dokka on this project and see the results. You should use a Dokka command you desire to write a plugin for (eg. dokkaHtml , dokkaGfm or other) with --info logging level. In project logs you should see the name of a plugin: Testing This project includes a test dependency on dokka-test-api and dokka-base-test","default_branch":null,"files":null,"tree":[],"storefront":"/r/Kotlin","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Kotlin/dokka-plugin-template/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}