chore(docs): migrate to mkdocs

FreifunkBremen · Sep 17, 2023 · dfd456b · dfd456b
1 parent 35e9253
commit dfd456b
Show file tree

Hide file tree

Showing 17 changed files with 583 additions and 953 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,25 @@
+name: Docs
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -4,6 +4,7 @@ on:
   workflow_run:
     workflows:
       - "Test, Lint"
+      - "Docs"
     types: [ "completed" ]
     branches:
       - main

diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ In the first step Yanic sends a multicast message to the group `ff05::2:1001` an
 Recently seen nodes that does not reply are requested via a unicast message.
 
 ## Documentation
-Take a look at the [git](https://github.com/FreifunkBremen/yanic/blob/main/SUMMARY.md) or [Gitbook](https://freifunkbremen.gitbooks.io/yanic/content/)
+Take a look at the [git](https://github.com/FreifunkBremen/yanic/blob/main/SUMMARY.md) or [website](https://freifunkbremen.github.io/yanic/)
 
 # Installation
 Take a look into the Documentation (see above) or for Quick Overview in [INSTALL.md](INSTALL.md).

diff --git a/SUMMARY.md b/SUMMARY.md
diff --git a/book.json b/book.json
diff --git a/docs/home_about.md → docs/about.md b/docs/home_about.md → docs/about.md
@@ -32,14 +32,16 @@ Nodes (respondd for nodes): [gluon](https://github.com/freifunk-gluon/gluon/)
 
 * [InfluxDB](https://influxdata.com/) SQL-like timeserial database
 * [Graphite](https://graphiteapp.org/) RRD file Based
+* and more
 
-	Visualization from Databases: [Grafana](https://grafana.com/)
+Visualization from Databases: [Grafana](https://grafana.com/)
 
 **Output:**
+
 * meshviewer-ffrgb:
-  * [meshviewer](https://github.com/ffrgb/meshviewer)
+    * [meshviewer](https://github.com/ffrgb/meshviewer)
 * nodelist:
-  * [ffapi](https://freifunk.net/api-generator/)
-    * [freifunk-karte.de](https://freifunk-karte.de)
+    * [ffapi](https://freifunk.net/api-generator/)
+        * [freifunk-karte.de](https://freifunk-karte.de)
 * meshviewer (others):
-  *  unmaintained [origin meshviewer](https://github.com/ffnord/meshviewer) branch: master (v1) and dev (v2)
+    *  unmaintained [origin meshviewer](https://github.com/ffnord/meshviewer) branch: master (v1) and dev (v2)
diff --git a/docs/dev_database.md → docs/dev/database.md b/docs/dev_database.md → docs/dev/database.md
diff --git a/docs/dev_output.md → docs/dev/output.md b/docs/dev_output.md → docs/dev/output.md