summaryrefslogtreecommitdiff
path: root/dokka-templates/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dokka-templates/README.md')
-rw-r--r--dokka-templates/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/dokka-templates/README.md b/dokka-templates/README.md
new file mode 100644
index 00000000..2b16f5bf
--- /dev/null
+++ b/dokka-templates/README.md
@@ -0,0 +1,12 @@
+# Dokka's template customization
+To provide unified navigation for all parts of [kotlinlang.org](https://kotlinlang.org/),
+the Kotlin Website Team uses this directory to place custom templates in this folder
+during the website build time on TeamCity.
+
+It is not practical to place these templates in the kotlinx.serialization repository because they change from time to time
+and aren't related to the library's release cycle.
+
+The folder is defined as a source for custom templates by the templatesDir property through Dokka's plugin configuration.
+
+[Here](https://kotlin.github.io/dokka/1.7.20-SNAPSHOT/user_guide/output-formats/html/#custom-html-pages), you can
+find more about the customization of Dokka's HTML output. \ No newline at end of file