site creator mkdocs

.github/workflows/build-gradle-project.yml

@@ -3,18 +3,22 @@ name: Build Gradle project
 on:
   push:
     branches:
+      - master
       - main
+# permissions
+permissions:
+  contents: write
+  deployments: write
+  pages: write
 # jobs
 jobs:
   build-gradle-project:
     runs-on: ubuntu-latest
-    # permissions
-    permissions:
-      contents: write
-      deployments: write
-      pages: write
     # job steps
     steps:
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
       # check out sources
       - name: Checkout project sources
         id: checkout_project
@@ -73,6 +77,13 @@ jobs:
           token: ${{ secrets.TOKEN }}
           tag: release-${{ env.GITHUB_APP_VERSION_NAME }}
           artifacts: './app/build/outputs/apk/release/app-release.apk, ./documentation/release-notes-*.md, ./release.zip, ./dependencies.md'
+      - uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install mkdocs-material
+      - run: pip install mkdocs-glightbox
+      - run: mkdocs gh-deploy --force
       # update wiki pages
       - name: Update wiki pages
         id: update_wiki_pages

mkdocs.yml

@@ -0,0 +1,47 @@
+site_name: Compose TV App and Lib
+docs_dir: documentation
+
+theme:
+  name: material
+  features:
+    - navigation.sections
+    - navigation.footer
+    - navigation.top
+  palette:
+    - scheme: slate
+      primary: teal
+      accent: teal
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+    - scheme: default
+      primary: teal
+      accent: teal
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+repo_name: mimoccc/tvapp
+repo_url: https://github.com/mimoccc/tvapp
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - attr_list
+  - md_in_html
+  - def_list
+
+plugins:
+  - glightbox
+
+nav:
+  - Home: home.md
+  - Release Notes: release-notes-1.3.1.md
+  - Code:
+      - Lib: documentation/lib/index.md
+      - App: documentation/app/index.md