{"id":19463765,"url":"https://github.com/adamko-dev/dokkatoo","last_synced_at":"2025-04-07T17:11:49.403Z","repository":{"id":65743678,"uuid":"598382061","full_name":"adamko-dev/dokkatoo","owner":"adamko-dev","description":"Generates documentation for Kotlin Gradle projects (based on Dokka)","archived":false,"fork":false,"pushed_at":"2024-10-29T10:34:54.000Z","size":17746,"stargazers_count":72,"open_issues_count":24,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-29T12:30:30.921Z","etag":null,"topics":["documentation","dokka","dokkatoo","gfm","gradle","gradle-plugin","html","javadoc","jekyll","kotlin"],"latest_commit_sha":null,"homepage":"https://adamko-dev.github.io/dokkatoo/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adamko-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-07T01:39:27.000Z","updated_at":"2024-10-26T10:58:22.000Z","dependencies_parsed_at":"2024-01-18T00:54:46.630Z","dependency_job_id":"6120a5c9-e1ad-47b9-add3-24a5c90016fc","html_url":"https://github.com/adamko-dev/dokkatoo","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamko-dev%2Fdokkatoo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamko-dev%2Fdokkatoo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamko-dev%2Fdokkatoo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamko-dev%2Fdokkatoo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamko-dev","download_url":"https://codeload.github.com/adamko-dev/dokkatoo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247694877,"owners_count":20980733,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","dokka","dokkatoo","gfm","gradle","gradle-plugin","html","javadoc","jekyll","kotlin"],"created_at":"2024-11-10T18:12:08.698Z","updated_at":"2025-04-07T17:11:49.332Z","avatar_url":"https://github.com/adamko-dev.png","language":"Kotlin","readme":"[![GitHub license](https://img.shields.io/github/license/adamko-dev/dokkatoo?style=for-the-badge)](https://github.com/adamko-dev/dokkatoo/blob/main/LICENSE)\n[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/dev.adamko.dokkatoo?style=for-the-badge\u0026logo=gradle)](https://plugins.gradle.org/search?term=dokkatoo)\n[![Maven Central](https://img.shields.io/maven-central/v/dev.adamko.dokkatoo/dokkatoo-plugin?style=for-the-badge\u0026logo=apache-maven\u0026color=6545e7\u0026link=https%3A%2F%2Fsearch.maven.org%2Fsearch%3Fq%3Dg%3Adev.adamko.dokkatoo)](https://search.maven.org/search?q=g:dev.adamko.dokkatoo)\n[![Maven Central Snapshots](https://img.shields.io/maven-metadata/v?label=MAVEN%20SNAPSHOT\u0026metadataUrl=https%3A%2F%2Fs01.oss.sonatype.org%2Fcontent%2Frepositories%2Fsnapshots%2Fdev%2Fadamko%2Fdokkatoo%2Fdokkatoo-plugin%2Fmaven-metadata.xml\u0026style=for-the-badge\u0026logo=apache-maven)](https://s01.oss.sonatype.org/content/repositories/snapshots/dev/adamko/dokkatoo/dokkatoo-plugin/)\n[![Slack](https://img.shields.io/badge/slack-%23dokka-white.svg?\u0026style=for-the-badge\u0026logo=slack)](https://slack-chats.kotlinlang.org/c/dokka)\n\n\u003cpicture\u003e\n  \u003cimg alt=\"Dokkatoo Logo\" src=\"./modules/docs/site/static/img/banner.svg\" style=\"margin: 1em\"\u003e\n\u003c/picture\u003e\n\n[Dokkatoo](https://github.com/adamko-dev/dokkatoo) is a\n[Gradle](https://gradle.org/)\nplugin that generates easy-to-use reference documentation for your\n[Kotlin](https://kotlinlang.org/) (or Java!) projects.\n\n## [For the full documentation, click here](https://adamko-dev.github.io/dokkatoo/)\n\n## What can Dokkatoo do?\n\n* **Automatic documentation** - Automatically generates up-to-date docs from your code, for both\n  Kotlin and Java projects.\n* **Format Flexibility** - Supports generating HTML, Javadoc, and Markdown output formats.\n* **Customization King** - Make your documentation truly yours. With Dokkatoo, you can customize the\n  output, including custom stylesheets and assets.\n* **Gradle's Best Friend** - Compatible with _all_ of Gradle's most powerful features!\n  Incremental compilation, multimodule builds, composite builds, Build Cache, Configuration Cache.\n\nUnder the hood Dokkatoo uses [Dokka](https://github.com/Kotlin/dokka/),\nthe API documentation engine for Kotlin.\n\n## Showcase\n\nFor real-life examples of the documentation that Dokkatoo generates,\n**check out** [**the showcase**](https://adamko-dev.github.io/dokkatoo/showcase)!\n\n## Getting Started\n\nView the\n[documentation](https://adamko-dev.github.io/dokkatoo/)\nfor more detailed instructions about how to set up and use Dokkatoo.\n\n### Quick start\n\nTo quickly generate documentation for your project, follow these steps.\n\n\u003e [!TIP]\n\u003e Dokkatoo supports multiple formats, but HTML is the quickest and easiest to get started with.\n\n1. Check the [Gradle Plugin Portal](https://plugins.gradle.org/plugin/dev.adamko.dokkatoo-html)\n   to find the latest version of Dokkatoo.\n2. Add the Dokkatoo plugin to your subproject:\n\n   ```kotlin\n   // build.gradle.kts\n\n   plugins {\n     kotlin(\"jvm\")\n     id(\"dev.adamko.dokkatoo-html\")\n   }\n   ```\n\n3. **(Optional)** If you'd like to combine multiple subprojects, add the Dokkatoo plugin to each\n   subproject, and\n   aggregate them in a single project by declaring dependencies to the subprojects.\n\n   ```kotlin\n   // build.gradle.kts\n   plugins {\n      id(\"dev.adamko.dokkatoo-html\")\n   }\n   \n   dependencies {\n     // Aggregate both subproject-hello and subproject-world into the current subproject.\n     // These subprojects must also have Dokkatoo applied.\n     dokkatoo(project(\":subproject-hello\"))\n     dokkatoo(project(\":subproject-world\"))\n   }\n   ```\n\n4. Run the generation task:\n\n   ```shell\n   ./gradlew :dokkatooGenerate\n   ```\n\n5. View the results in `./build/dokka/`\n\nFor more detailed instructions about how to set up and use Dokkatoo, and control the output,\n[more guides are available in the docs](https://adamko-dev.github.io/dokkatoo/docs).\n\n## Releases\n\nDokkatoo is available from the\n[Gradle Plugin Portal](https://plugins.gradle.org/search?term=dokkatoo)\nand\n[Maven Central](https://search.maven.org/search?q=g:dev.adamko.dokkatoo).\n[Snapshot releases](https://adamko-dev.github.io/dokkatoo/docs/releases#snapshots)\nare also available.\n\nMore details about the Dokkatoo releases is available in the documentation\n[Dokkatoo Documentation](https://adamko-dev.github.io/dokkatoo/docs/releases)\n\n## Why not Dokka?\n\nIf\n[Dokka already has a Gradle plugin](https://kotlinlang.org/docs/dokka-gradle.html),\nthen what is Dokkatoo for?\n\nDokkatoo has a number of improvements over the existing Dokka Gradle Plugin:\n\n* Compatible with [Gradle Build Cache](https://docs.gradle.org/current/userguide/build_cache.html).\n* Compatible with\n  [Gradle Configuration Cache](https://docs.gradle.org/current/userguide/configuration_cache.html).\n* Follows Gradle best practices for plugin development, for a more stable experience.\n* Faster, parallel execution.\n\n### Migrating from Dokka Gradle Plugin\n\nMigrating from Dokka to Dokkatoo can be done in a few simple steps.\nCheck the [Dokkatoo Documentation](https://adamko-dev.github.io/dokkatoo/)\nto get started.\n\nIf you'd like to see comparative examples of the same projects with both Dokka and Dokkatoo config,\ncheck the [example projects](./examples/README.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamko-dev%2Fdokkatoo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamko-dev%2Fdokkatoo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamko-dev%2Fdokkatoo/lists"}