aboutsummaryrefslogtreecommitdiff
path: root/mkdocs/README.md
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-08-04 18:59:28 +0200
committerGitHub <noreply@github.com>2023-08-04 18:59:28 +0200
commitf7bd2ce1a5ef194643b078bd11a90fdf9b389c2b (patch)
tree2f26d61ed1f90f5a2c3405b70c651607f97506d7 /mkdocs/README.md
parentb559131ddda8efea3394a0ea641460c4189769db (diff)
downloaddokka-f7bd2ce1a5ef194643b078bd11a90fdf9b389c2b.tar.gz
dokka-f7bd2ce1a5ef194643b078bd11a90fdf9b389c2b.tar.bz2
dokka-f7bd2ce1a5ef194643b078bd11a90fdf9b389c2b.zip
Update Developer Guides (#3088)
Diffstat (limited to 'mkdocs/README.md')
-rw-r--r--mkdocs/README.md33
1 files changed, 0 insertions, 33 deletions
diff --git a/mkdocs/README.md b/mkdocs/README.md
deleted file mode 100644
index c8d07370..00000000
--- a/mkdocs/README.md
+++ /dev/null
@@ -1,33 +0,0 @@
-# MkDocs documentation
-
-This module contains documentation which is published to GitHub pages:
-[kotlin.github.io/dokka](https://kotlin.github.io/dokka/).
-
-It is built using the [gradle-mkdocs-plugin](https://github.com/xvik/gradle-mkdocs-plugin).
-
-## Building
-
-You can build the documentation locally:
-
-```Bash
-./gradlew :mkdocs:mkdocsBuild
-```
-
-The output directory is `build/mkdocs`
-
-### Livereload server
-
-Alternatively, you can run a livereload server that automatically rebuilds documentation on every change:
-
-```Bash
-./gradlew :mkdocs:mkdocsServe
-```
-
-By default, it is run under [127.0.0.1:3001](http://127.0.0.1:3001/), but you can change it in
-[mkdocs.yml](src/doc/mkdocs.yml) by setting the `dev_addr` option.
-
-## Publishing
-
-The documentation is published automatically for all changes in master and for every GitHub release.
-
-See [gh-pages.yml](../.github/workflows/gh-pages.yml) workflow configuration for more details.