-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add Dokka HTML module info (finally!) * update attributes in buildsrc convention Configurations * add Dokkatoo example for versioning-multimodule * add Writerside docs * add kotlin-as-java Dokkatoo example * generate dokka into a nested /kdoc/ directory for GitHub Pages * hide previousDocVersions from GitHub stats/diffs * Revert GitHub Action pages Upload path change (path was changed in the build script instead) * update example projects docs, and minor fixes * move writerside docs up one level * GitHub pages tweaks for Writerside * update workflow for writerside * move Writerside env vars to relevant task
- Loading branch information
Showing
204 changed files
with
12,497 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| plugins { | ||
| kotlin("jvm") version "1.9.23" | ||
| id("dev.adamko.dokkatoo") version "2.3.0-SNAPSHOT" | ||
| } | ||
|
|
||
| dependencies { | ||
| testImplementation(kotlin("test-junit")) | ||
|
|
||
| // Will apply the plugin only to the `:dokkaHtml` task | ||
| // (Dokkatoo will automatically add the version) | ||
| dokkatooPluginHtml("org.jetbrains.dokka:kotlin-as-java-plugin") | ||
|
|
||
| // Will apply the plugin only to the `:dokkaGfm` task | ||
| // (Dokkatoo will automatically add the version) | ||
| dokkatooPluginGfm("org.jetbrains.dokka:kotlin-as-java-plugin") | ||
| } |
20 changes: 20 additions & 0 deletions
20
examples/kotlin-as-java-example/dokkatoo/src/main/kotlin/demo/HelloWorld.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| package demo | ||
|
|
||
| /** | ||
| * This class supports greeting people by name. | ||
| * | ||
| * @property name The name of the person to be greeted. | ||
| */ | ||
| class Greeter(val name: String) { | ||
|
|
||
| /** | ||
| * Prints the greeting to the standard output. | ||
| */ | ||
| fun greet() { | ||
| println("Hello $name!") | ||
| } | ||
| } | ||
|
|
||
| fun main(args: Array<String>) { | ||
| Greeter(args[0]).greet() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
...iousDocVersions/0.9/childProjectA/demo/-child-project-a-class/-child-project-a-class.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| <!doctype html> | ||
| <html> | ||
| <head> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> | ||
| <title>ChildProjectAClass</title> | ||
| <link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode") | ||
| if (storage == null) { | ||
| const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches | ||
| if (osDarkSchemePreferred === true) { | ||
| document.getElementsByTagName("html")[0].classList.add("theme-dark") | ||
| } | ||
| } else { | ||
| const savedDarkMode = JSON.parse(storage) | ||
| if(savedDarkMode === true) { | ||
| document.getElementsByTagName("html")[0].classList.add("theme-dark") | ||
| } | ||
| } | ||
| </script> | ||
| <script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script> | ||
| <link href="../../../styles/style.css" rel="Stylesheet"> | ||
| <link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"> | ||
| <link href="../../../styles/main.css" rel="Stylesheet"> | ||
| <link href="../../../styles/prism.css" rel="Stylesheet"> | ||
| <link href="../../../styles/logo-styles.css" rel="Stylesheet"> | ||
| <script type="text/javascript" src="../../../scripts/clipboard.js" async></script> | ||
| <script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script> | ||
| <script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script> | ||
| <script type="text/javascript" src="../../../scripts/main.js" defer></script> | ||
| <script type="text/javascript" src="../../../scripts/prism.js" async></script> | ||
| <script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script> | ||
| <link href="../../../styles/multimodule.css" rel="Stylesheet"></head> | ||
| <body> | ||
| <div class="navigation-wrapper" id="navigation-wrapper"> | ||
| <div id="leftToggler"><span class="icon-toggler"></span></div> | ||
| <div class="library-name"> | ||
| <a href="../../../index.html"> | ||
| <span>parentProject</span> </a> </div> | ||
| <div> | ||
| <dokka-template-command data="{"@class":"org.jetbrains.dokka.base.templating.ReplaceVersionsCommand","location":"demo/-child-project-a-class/-child-project-a-class.html"}">0.9</dokka-template-command> </div> | ||
| <div class="pull-right d-flex"> | ||
| <button id="theme-toggle-button"><span id="theme-toggle"></span></button> | ||
| <div id="searchBar"></div> | ||
| </div> | ||
| </div> | ||
| <div id="container"> | ||
| <div id="leftColumn"> | ||
| <div id="sideMenu"></div> | ||
| </div> | ||
| <div id="main"> | ||
| <div class="main-content" id="content" pageids="childProjectA::demo/ChildProjectAClass/ChildProjectAClass/#/PointingToDeclaration//-638285599"> | ||
| <div class="breadcrumbs"><a href="../../index.html">childProjectA</a><span class="delimiter">/</span><a href="../index.html">demo</a><span class="delimiter">/</span><a href="index.html">ChildProjectAClass</a><span class="delimiter">/</span><span class="current">ChildProjectAClass</span></div> | ||
| <div class="cover "> | ||
| <h1 class="cover"><span>Child</span><wbr><span>Project</span><wbr><span><span>AClass</span></span></h1> | ||
| </div> | ||
| <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":parentProject:childProjectA:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-child-project-a-class.html"><span class="token function">ChildProjectAClass</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div> | ||
| </div> | ||
| <div class="footer"> | ||
| <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| </body></html> | ||
|
|
Oops, something went wrong.