# HG changeset patch
# User Da Risk <da_risk@geekorum.com>
# Date 1746393306 14400
# Node ID bcfc8238b4f61639f2437ec4275eeddbd3470c84
# Parent  57d9068de0efefa61f2560a2703dce89efe19d26
docs: start documentation using mkdocs

diff -r 57d9068de0ef -r bcfc8238b4f6 .hgignore
--- a/.hgignore	Sun May 04 16:05:40 2025 -0400
+++ b/.hgignore	Sun May 04 17:15:06 2025 -0400
@@ -65,3 +65,6 @@
 
 # Android studio captures
 captures/
+
+# generated api docs
+docs/api/
\ No newline at end of file
diff -r 57d9068de0ef -r bcfc8238b4f6 README.md
--- a/README.md	Sun May 04 16:05:40 2025 -0400
+++ b/README.md	Sun May 04 17:15:06 2025 -0400
@@ -13,13 +13,13 @@
 
 In your app-level `build.gradle`, apply the plugin by adding the following line under the existing `apply plugin: 'com.android.application'` at the top of the file:
 
-```build.gradle.kts
+```kotlin title="build.gradle.kts"
 apply plugin: 'com.google.android.gms.oss-licenses-plugin'
 ```
 
 ### Add the ui library to your application
 
-```build.gradle.kts
+```kotlin title="build.gradle.kts"
 repositories {
     maven {
         url = uri("https://jitpack.io")
@@ -33,7 +33,7 @@
 
 ### Launch the license activity
 
-```
+```kotlin
 val intent = Intent(this, OpenSourceLicensesActivity::class.java)
 startActivity(intent)
 ```
diff -r 57d9068de0ef -r bcfc8238b4f6 docs/index.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/index.md	Sun May 04 17:15:06 2025 -0400
@@ -0,0 +1,1 @@
+../README.md
\ No newline at end of file
diff -r 57d9068de0ef -r bcfc8238b4f6 dokka/build.gradle.kts
--- a/dokka/build.gradle.kts	Sun May 04 16:05:40 2025 -0400
+++ b/dokka/build.gradle.kts	Sun May 04 17:15:06 2025 -0400
@@ -32,4 +32,9 @@
 
 dokka {
     moduleName = "AboutOss"
+    dokkaPublications {
+        html {
+            outputDirectory = rootDir.resolve("docs/api")
+        }
+    }
 }
\ No newline at end of file
diff -r 57d9068de0ef -r bcfc8238b4f6 mkdocs.yml
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mkdocs.yml	Sun May 04 17:15:06 2025 -0400
@@ -0,0 +1,42 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
+
+site_name: AboutOss
+copyright: 'Copyright &copy; 2025 Frédéric Barthéléry'
+repo_url: https://github.com/fbarthelery/AboutOss
+
+theme:
+  name: material
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: '(prefers-color-scheme: dark)'
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  icon:
+    repo: fontawesome/brands/github
+
+  features:
+    - content.code.copy
+
+markdown_extensions:
+  - pymdownx.highlight:
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+nav:
+  - Home: index.md
+  - API: api/index.html
+  - "Discussions ⏏": https://github.com/fbarthelery/AboutOss/discussions
\ No newline at end of file