First version of mkdocs page

.github/workflows/deploy-docs.yml

@@ -0,0 +1,63 @@
+name: Deploy docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy_docs:
+
+    runs-on: macos-14
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: 'true'
+
+      - name: Setup JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install mkdocs mkdocs-material mkdocs-video "mkdocs-material[imaging]"
+
+      - uses: gradle/gradle-build-action@v3
+
+      - run: ./gradlew :dokkaHtmlMultiModule --no-configuration-cache
+
+      - name: Build site
+        run: mkdocs build
+
+      - name: Copy Dokka output to site
+        run: cp -r build/dokka/htmlMultiModule/ site/api/
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'site'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -14,3 +14,4 @@
 .cxx
 local.properties
 /.idea/
+/site/

build.gradle.kts

@@ -2,4 +2,5 @@ plugins {
     alias(libs.plugins.androidApplication) apply false
     alias(libs.plugins.androidLibrary) apply false
     alias(libs.plugins.kotlin) apply false
+    alias(libs.plugins.dokka)
 }

mkdocs.yml

@@ -0,0 +1,23 @@
+site_name: Navigation Compose Extended
+site_description: 'A collection of classes and functions to simplify the use of Jetpack Navigation Compose.'
+site_author: 'Sergio Belda'
+site_url: 'https://serbelga.github.io/navigation-compose-extended/'
+edit_uri: 'tree/main/docs/'
+remote_branch: gh-pages
+
+repo_name: 'navigation-compose-extended'
+repo_url: 'https://github.com/serbelga/navigation-compose-extended'
+
+docs_dir: docs
+
+nav:
+  - 'Overview': index.md
+  - 'API Reference': api/
+  - 'Sample App': https://github.com/serbelga/navigation-compose-extended/tree/main/sample-app
+
+theme:
+  name: 'material'
+  palette:
+    primary: 'black'
+  icon:
+    logo: material/navigation