UI improvements
### Renderer - Overloads are now better separated, thanks to a background color (#36, !101) - Overloads that have the exact same documentation are joined into a single block (#34, !102) - Fixed the rendering of annotations (#32, !99) - Fixed titles in function descriptions being the same level as the function itself (3e79a3ef, !100) - Fixed titles in function descriptions being listed in the table of contents (#33, 097b2d59, !100)
Dokka 2.2.0
### Gradle plugin - Refuse to overwrite files (2ef5c568, !94) - Removed mentions of Dokkatoo in task descriptions (fea0f089, !94) ### Dependencies - Dokka 2.2.0 - Gradle 9.4.1
Dokka 2.1.0
### Deployment - Fixed the module `:aggregator` not being published to MavenCentral (!92) ### Dependencies - Dokka 2.1.0
Beta graduation, improved paths & improved UX
### Graduation to beta! This release contains a large amount of fixes and UX improvements for long-standing issues. The configuration doesn't change, but the URL of generated pages does. This release includes all the major changes we expected before stabilization. **We are thus officially graduating this project to Beta!** There may still be bugs to fix, but we are not planning breaking changes, so this is the best time to send us feedback. Thanks to @t-regbs for contributing multiple fixes. Thanks to the Dokka team for a multi-months discussion that lead to figuring out the source of these problems. ### Generated pages - Methods with many parameters are now displayed on multiple lines (#25, !77, thanks @t-regbs!) - Fixed links within Markdown code blocks (#26, !80, thanks @t-regbs!) - Package pages are titled after the technical name of the package (ce5c3235) - Fixed the hover page not matching module, package and class pages (d2aa20b0, 45588c41) - The navigation bar and breadcrumbs use a module's technical name (bc30a010) - The navigation bar and breadcrumbs now display packages hierarchically (#15, 03e6c05e, !87) - Each types outputs a single page, instead of each property/function having a dedicated subpage (512948aa) - Reworked how the 'Parameters:', 'Return:', 'See also:' sections are displayed (59fb4a68, 4cf65fcb, 48d5f317) - Fixed links to methods in code blocks (c6fa9fe5) - Fixed links with anchors in code blocks (e779a72e) ### Aggregator This version contains a large refactor from a single `:renderer` module to the addition of an `:aggregator` module. Configuration for users does not change. However, the output does. Previously, the paths contained the display name of each module, they know contain its technical name: ``` # Before: /api/an%20example%20-library%20-module/… # After: /api/example-lib/… ``` Additionally, this allows us to fix multiple long-standing issues: - Added a reference-wide page which lists modules (50f13490) - Fixed cross-module links (6aae5ade) ### Making it easier to find information Kotlin allows library authors to structure code in various creative ways for different reasons. However, this can make the generated documentation harder to navigate. To facilitate finding information, the generated documentation hides some of these structuring decisions: - Extension functions declared in the same package as their receiver are listed in the receiver's page, alongside its regular functions (86dc24cc) - Top-level functions that have the same name as a type and return it ("fake constructors") are now listed in the type's page, alongside its regular constructors (448ee457) Our goal is to make it easier for users to find information. We're interested in your feedback. ### Dependencies - Kotlin 2.3.10 - Gradle 9.3.1 - Java 17+ required, same as Gradle itself (previously Java 8+)
Dependency upgrades, breadcrumb removal
### Renderer - Removed the navigation breadcrumbs, as it is now natively available in Material MkDocs (94f75290, !73) - Removed the unused renderer v1 and v2 implementations ### Documentation - Enabled more Material MkDocs features (!72) ### Dependencies - Kotlin 2.3.0 - Gradle 9.2.1 - Dokka 2.1.0
Bug fixes, new documentation site and dependency upgrades
### Gradle plugin - Fixed build failure when running `./gradlew clean` ### Documentation - Moved the documentation site to [dokka-mkdocs.opensavvy.dev](https://dokka-mkdocs.opensavvy.dev/) ### Dependencies - Gradle 8.14 - Kotlin 2.2.0 - Dokka 2.0.0 stable
Removal of the Dokkatoo plugin, integration with the `:clean` task
### Dokkatoo plugin The Dokkatoo plugin has been removed (#19, !37). Please migrate to the Dokka v2 plugin instead. ### Dokka plugin - The `:clean` task now deletes all files generated by the plugin (#20, !38) - The plugin automatically generates a `.gitignore` file in the `/api` folder (!38)
Quotations, fixed spacing in `@see`, links as code
### Renderer - Implemented quotation blocks (1c2d4784, !34) - Fixed spacing in `@see` (!955acd07, !34) - Links to code locations are now displayed in monospace font (2d768cf6, !34) ### Documentation - Fixed the `@params` tag (b6c02ce0, !34) ### Dependencies - Kotlin 2.1.20 (7fa93efc, !32)
Complete rewrite
### Renderer This release contains a complete reimplementation of the renderer (!27). It now knows how to render: - A navigation bar on each page - Page metadata (available platforms) - Headers - Platform-specific content - Code blocks - Inline code - Hyperlinks (local and external) - Bold, italic and strikethrough text - Package lists - Type lists - Function & constructor lists - Property lists - Inheritor lists - Ordered and unordered lists - The `@throws` and `@see` tags - Type parameters Known issues in this version: - Hyperlinks in module header pages are broken. Links in all other pages should work. - Platform-specific tabs are sometimes weird for expect/actual symbols. ### Documentation - Added a mention that `use_directory_urls` is forbidden (#14, !29) - Added a 'News' section which contains releases (!30) ### Dependencies - Kotlin 2.1.10
Recommend Dokka 2.0, fix broken links
### Documentation - Update the setting up guide to recommend Dokka v2 instead of Dokkatoo (#7, !26) - Fix broken links in the main README (#9, #10, !25) ### Dependencies - Kotlin 2.1.0
Escape fixes
### Dokka support - Fix broken directory names when using colons (#8, !19) ### Renderer - Fix broken page titles when using colons (#8, !19)
Stability improvements, constructors and properties
### Dokka support - Avoid relying on internal Dokka APIs (ffb4e988, !17) - Fix the plugin attempting to pull an inexistant version of the renderer (923a4f12, !17) - Fix broken navigation titles for CamelCase declarations (e87c04fc, !16) - Place top-level factories right after their class (f84849fa, !18) ### Dokkatoo support - Fix the plugin attempting to pull an inexistant version of the renderer (4a826f19, !17) - Fix broken navigation titles for CamelCase declarations (d1bbf707, !16) ### Renderer - List constructors in a class' page (!18) - List properties in a class' or package's page (!18)
Dokka v2 support
### Dokka - Create a Gradle plugin to integrate with Dokka v2 (#6, !14) ### Documentation - Add module headers (!13) - Add a setup guide in the main README (!14)
Fix publishing, configuration guide
### Documentation - Add a configuration guide on the website (!12) - Improve the example's module header (!12) ### Deployment - Fix MavenCentral publishing (!12)
First published version, module and package headers, table of contents
### Renderer - Prepare for MavenCentral publication (!9) - Fix broken module page when module name contains spaces (!10) - Support module header description via 'includes' (!10) - Fix table of contents not appearing on any pages (!10) - Classes and top-level functions are displayed in each package's page (!10) ### Dokkatoo plugin - All pages are added to the MkDocs navigation (!7) - Prepare for MavenCentral publication (!9)
### Renderer
- Generate the module index in the module folder to avoid collisions with other modules (!4) - Improve the design of the navigation bar (!4) - Display source sets as MkDocs tags (!4) - Render page covers as code blocks (!4) - Improve the design of parameter lists (!4) - Fix broken links (!5) - Declare each implemented platforms as MkDocs tags (!5) - Set the page title based on the first listed symbol (!5) - Rewrite regular text display (!5) - Add full Dokka internal representation in HTML comments for easier debugging (!5) - Mark groups that are platform-dependent (!5) - Render code blocks accurately (!5) - Mark overloads with an horizontal rule (!5) ### Dokkatoo plugin - Convert :embedDokkaIntoMkDocs to a lifecycle task (be7d1459, !4) ### Examples - Create an example-app module (!4)