Tags

Tags give the ability to mark specific points in history as being important
  • 0.5.4

    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
    
  • 0.5.3

    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
    
  • 0.5.2

    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)
    
  • 0.5.1

    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)
    
  • 0.5.0

    95943e53 · merge: Renderer v3 ·
    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
    
  • 0.4.3

    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
    
  • 0.4.2

    e79f9740 · merge: Escape yaml keys ·
    Escape fixes
    
    ### Dokka support
    
    - Fix broken directory names when using colons (#8, !19)
    
    ### Renderer
    
    - Fix broken page titles when using colons (#8, !19)
    
  • 0.4.1

    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)
    
  • 0.4.0

    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)
    
  • 0.3.1

    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)
    
  • 0.3.0

    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)
    
  • 0.2.0

    305e6a2b · merge: Improved design ·
    ### 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)
    
  • 0.1.0

    Project initialization
    
    ### Renderer
    
    - Fork the official GFM format (#1, !2)
    
    ### Dokkatoo plugin
    
    - Create a Dokkatoo-based Gradle plugin to generate the documentation (#3, !3)
    
    ### Documentation
    
    - Create an example project (!2)