From bfa391068b8641faecf4724936f86fef61ea2130 Mon Sep 17 00:00:00 2001 From: Sargun Vohra Date: Mon, 2 Dec 2024 18:25:03 -0800 Subject: [PATCH] install mkdocs (#84) --- build.gradle.kts | 5 ++- docs/docs/index.md | 3 ++ docs/mkdocs.yml | 70 +++++++++++++++++++++++++++++++++++++++ gradle/libs.versions.toml | 1 + 4 files changed, 78 insertions(+), 1 deletion(-) create mode 100644 docs/docs/index.md create mode 100644 docs/mkdocs.yml diff --git a/build.gradle.kts b/build.gradle.kts index 91e137cb..f50e08da 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -9,9 +9,12 @@ plugins { alias(libs.plugins.kotlin.cocoapods) apply false alias(libs.plugins.spotless) alias(libs.plugins.dokka) + alias(libs.plugins.mkdocs) } -dokka { moduleName = "MapLibre Compose" } +mkdocs { sourcesDir = "docs" } + +dokka { moduleName = "MapLibre Compose API Reference" } dependencies { dokka(project(":lib:maplibre-compose:")) } diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 00000000..bfb8b2b7 --- /dev/null +++ b/docs/docs/index.md @@ -0,0 +1,3 @@ +# MapLibre Compose + +TODO diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 00000000..981cd754 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,70 @@ +site_name: MapLibre Compose + +site_description: MapLibre Compose embeds interactive vactor map in your Compose Multiplatform apps. +site_url: https://sargunv.github.io/maplibre-compose + +repo_name: maplibre-compose +repo_url: http://github.com/sargunv/maplibre-compose +edit_uri: "edit/main/docs/docs/" + +copyright: "Copyright © 2024 Sargun Vohra" + +theme: + name: "material" + icon: + repo: "fontawesome/brands/github" + palette: + - media: "(prefers-color-scheme)" + features: + - navigation.instant + - navigation.instant.prefetch + - navigation.instant.progress + - navigation.instant.preview + - navigation.tracking + - navigation.expand + - navigation.path + - navigation.indexes + - toc.follow + - content.action.edit + +plugins: + - search + - markdownextradata + +markdown_extensions: + # Python Markdown + - abbr + - admonition + - attr_list + - def_list + - footnotes + - meta + - md_in_html + - toc: + permalink: true + - tables + + # Python Markdown Extensions + - pymdownx.arithmatex: + generic: true + - pymdownx.betterem: + smart_enable: all + - pymdownx.caret + - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight + - pymdownx.inlinehilite + - pymdownx.keys + - pymdownx.mark + - pymdownx.smartsymbols + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde + +nav: + - Home: index.md diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index c730eada..01b30e6a 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -33,4 +33,5 @@ kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "ko kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" } kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" } maven-publish = { id = "com.vanniktech.maven.publish", version = "0.30.0" } +mkdocs = { id = "ru.vyarus.mkdocs-build", version = "4.0.1" } spotless = { id = "com.diffplug.spotless", version = "7.0.0.BETA4" }