Feat: replace jekyll with mkdocs

jcorporation · Sep 22, 2024 · e1fc2d4 · e1fc2d4
1 parent 0cd2471
commit e1fc2d4
Show file tree

Hide file tree

Showing 88 changed files with 103 additions and 350 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -30,14 +30,7 @@ jobs:
         run: |
           sudo apt-get install -y doxygen graphviz luadoc
           sudo npm install --location=global jsdoc
-          ./build.sh api_doc
-      - name: Setup Pages
-        uses: actions/configure-pages@v5
-      - name: Build with Jekyll
-        uses: actions/jekyll-build-pages@v1
-        with:
-          source: ./docs
-          destination: ./_site
+          ./build.sh doc _site
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
 

diff --git a/.gitignore b/.gitignore
@@ -38,8 +38,8 @@
 /docs/assets/apidoc.js
 /docs/scripting/scripts/index.json
 /docs/.jekyll-cache/
-/docs/_site/
 /docs/luadoc/
+_site/
 
 #private files
 .secrets
diff --git a/build.sh b/build.sh
@@ -473,8 +473,7 @@ cleanup() {
   rm -rf htdocs/assets/i18n
 
   #generated documentation
-  rm -rf docs/_site
-  rm -rf docs/.jekyll-cache
+  rm -rf _site
   rm -rf docs/doxygen
   rm -rf docs/jsdoc
 
@@ -1357,21 +1356,17 @@ run_luadoc() {
 
 create_doc() {
   DOC_DEST=$1
-  if ! check_cmd jekyll
+  install -d "$DOC_DEST" || return 1
+  if ! check_cmd python3
   then
-    echo "Jekyll not installed, can not create documentation"
+    echo "Python3 not installed, can not create documentation"
     return 1
   fi
-  if ! run_doxygen
-  then
-    echo "Skipped generation of c api documentation"
-  fi
-  if ! run_jsdoc
-  then
-    echo "Skipped generation of js api documentation"
-  fi
-  install -d "$DOC_DEST" || return 1
-  jekyll build -s "$STARTPATH/docs" -d "$DOC_DEST"
+  ./build.sh api_doc
+  python3 -m venv ~/python-venv/
+  ~/python-venv/bin/pip install mkdocs mkdocs-material \
+      mkdocs-include-markdown-plugin mkdocs-awesome-pages-plugin
+  ~/python-venv/bin/mkdocs build -d "$DOC_DEST"
 }
 
 translation_import() {

diff --git a/docs/.pages b/docs/.pages
@@ -0,0 +1 @@
+order_by: filename
diff --git a/docs/index.md → docs/000-index.md b/docs/index.md → docs/000-index.md
@@ -1,7 +1,7 @@
 ---
 layout: page
 permalink: /
-title: myMPD documentation
+title: myMPD Documentation
 ---
 
 myMPD is a standalone and mobile friendly web-based MPD client with a tiny footprint and advanced features.
@@ -12,12 +12,5 @@ myMPD is a standalone and mobile friendly web-based MPD client with a tiny footp
 
 To use all myMPD functions you should use the latest stable MPD version.
 
-This documentation is for myMPD version {% include version %}.
+This documentation is for myMPD version {% include-markdown "_includes/version" %}.
 
-<div id="toc" class="d-none">
-    {% include nav.html %}
-</div>
-
-***
-
-<a href="https://github.com/jcorporation">&copy; 2018-2024 Jürgen Mang</a>
diff --git a/docs/010-installation/.pages b/docs/010-installation/.pages
@@ -0,0 +1 @@
+title: Installation
diff --git a/docs/installation/compiling/build-sh.md → docs/010-installation/compiling/build-sh.md b/docs/installation/compiling/build-sh.md → docs/010-installation/compiling/build-sh.md
@@ -1,6 +1,4 @@
 ---
-layout: page
-permalink: /installation/compiling/build-sh
 title: Compiling with build.sh
 ---
 

diff --git a/docs/installation/compiling/cmake.md → docs/010-installation/compiling/cmake.md b/docs/installation/compiling/cmake.md → docs/010-installation/compiling/cmake.md
@@ -1,6 +1,4 @@
 ---
-layout: page
-permalink: /installation/compiling/cmake
 title: Compiling with cmake
 ---
 
@@ -37,7 +35,6 @@ sudo make -C build install
 | MYMPD_MANPAGES | ON | Creates and installs manpages |
 | MYMPD_MINIMAL | OFF | Enables minimal myMPD build, disables all MYMPD_ENABLE_* flags |
 | MYMPD_STARTUP_SCRIPT | ON | Installs the startup script, valid values: ON, OFF, SYSTEMD, OPENRC, SYSVINIT, FREEBSD |
-{: .table .table-sm}
 
 ## cmake build types
 

diff --git a/docs/installation/compiling/freebsd.md → docs/010-installation/compiling/freebsd.md b/docs/installation/compiling/freebsd.md → docs/010-installation/compiling/freebsd.md
@@ -1,6 +1,4 @@
 ---
-layout: page
-permalink: /installation/compiling/freebsd
 title: FreeBSD
 ---
 

diff --git a/docs/installation/compiling/index.md → docs/010-installation/compiling/index.md b/docs/installation/compiling/index.md → docs/010-installation/compiling/index.md
diff --git a/docs/installation/compiling/openwrt.md → docs/010-installation/compiling/openwrt.md b/docs/installation/compiling/openwrt.md → docs/010-installation/compiling/openwrt.md
diff --git a/docs/installation/compiling/termux.md → docs/010-installation/compiling/termux.md b/docs/installation/compiling/termux.md → docs/010-installation/compiling/termux.md
diff --git a/docs/installation/distributions.md → docs/010-installation/distributions.md b/docs/installation/distributions.md → docs/010-installation/distributions.md
diff --git a/docs/installation/docker.md → docs/010-installation/docker.md b/docs/installation/docker.md → docs/010-installation/docker.md
diff --git a/docs/installation/index.md → docs/010-installation/index.md b/docs/installation/index.md → docs/010-installation/index.md
@@ -1,6 +1,4 @@
 ---
-layout: page
-permalink: /installation/
 title: Installation
 ---
 

diff --git a/.../installation/prebuild-packages-debian.md → ...-installation/prebuild-packages-debian.md b/.../installation/prebuild-packages-debian.md → ...-installation/prebuild-packages-debian.md
diff --git a/docs/installation/prebuild-packages.md → docs/010-installation/prebuild-packages.md b/docs/installation/prebuild-packages.md → docs/010-installation/prebuild-packages.md
diff --git a/docs/020-configuration/.pages b/docs/020-configuration/.pages
@@ -0,0 +1 @@
+title: Configuration
diff --git a/docs/configuration/acl.md → docs/020-configuration/acl.md b/docs/configuration/acl.md → docs/020-configuration/acl.md
diff --git a/docs/configuration/command-line-options.md → ...020-configuration/command-line-options.md b/docs/configuration/command-line-options.md → ...020-configuration/command-line-options.md
diff --git a/docs/configuration/configuration-files.md → .../020-configuration/configuration-files.md b/docs/configuration/configuration-files.md → .../020-configuration/configuration-files.md
diff --git a/docs/configuration/index.md → docs/020-configuration/index.md b/docs/configuration/index.md → docs/020-configuration/index.md
diff --git a/docs/configuration/logging.md → docs/020-configuration/logging.md b/docs/configuration/logging.md → docs/020-configuration/logging.md
diff --git a/docs/configuration/mpd-connection.md → docs/020-configuration/mpd-connection.md b/docs/configuration/mpd-connection.md → docs/020-configuration/mpd-connection.md
diff --git a/docs/configuration/pin-protection.md → docs/020-configuration/pin-protection.md b/docs/configuration/pin-protection.md → docs/020-configuration/pin-protection.md
diff --git a/docs/configuration/ssl.md → docs/020-configuration/ssl.md b/docs/configuration/ssl.md → docs/020-configuration/ssl.md
diff --git a/docs/running.md → docs/030-running.md b/docs/running.md → docs/030-running.md
diff --git a/docs/debug.md → docs/040-debug.md b/docs/debug.md → docs/040-debug.md
diff --git a/docs/050-scripting/.pages b/docs/050-scripting/.pages
@@ -0,0 +1 @@
+title: Scripting
diff --git a/docs/scripting/functions/diskcache.md → docs/050-scripting/functions/diskcache.md b/docs/scripting/functions/diskcache.md → docs/050-scripting/functions/diskcache.md
diff --git a/docs/scripting/functions/gpio.md → docs/050-scripting/functions/gpio.md b/docs/scripting/functions/gpio.md → docs/050-scripting/functions/gpio.md
diff --git a/docs/scripting/functions/http_client.md → docs/050-scripting/functions/http_client.md b/docs/scripting/functions/http_client.md → docs/050-scripting/functions/http_client.md
diff --git a/docs/scripting/functions/http_replies.md → docs/050-scripting/functions/http_replies.md b/docs/scripting/functions/http_replies.md → docs/050-scripting/functions/http_replies.md
diff --git a/docs/scripting/functions/index.md → docs/050-scripting/functions/index.md b/docs/scripting/functions/index.md → docs/050-scripting/functions/index.md
diff --git a/docs/scripting/functions/json.md → docs/050-scripting/functions/json.md b/docs/scripting/functions/json.md → docs/050-scripting/functions/json.md
diff --git a/docs/scripting/functions/mympd_api.md → docs/050-scripting/functions/mympd_api.md b/docs/scripting/functions/mympd_api.md → docs/050-scripting/functions/mympd_api.md
diff --git a/docs/scripting/functions/mympd_dialog.md → docs/050-scripting/functions/mympd_dialog.md b/docs/scripting/functions/mympd_dialog.md → docs/050-scripting/functions/mympd_dialog.md
diff --git a/docs/scripting/functions/mympd_init.md → docs/050-scripting/functions/mympd_init.md b/docs/scripting/functions/mympd_init.md → docs/050-scripting/functions/mympd_init.md
diff --git a/docs/scripting/functions/system_command.md → ...050-scripting/functions/system_command.md b/docs/scripting/functions/system_command.md → ...050-scripting/functions/system_command.md
diff --git a/docs/scripting/functions/util.md → docs/050-scripting/functions/util.md b/docs/scripting/functions/util.md → docs/050-scripting/functions/util.md
diff --git a/docs/scripting/index.md → docs/050-scripting/index.md b/docs/scripting/index.md → docs/050-scripting/index.md
diff --git a/docs/scripting/mympd-script.md → docs/050-scripting/mympd-script.md b/docs/scripting/mympd-script.md → docs/050-scripting/mympd-script.md
@@ -1,7 +1,5 @@
 ---
-layout: page
-permalink: /scripting/mympd-script
-title: Scripting
+title: mympd-script
 ---
 
 `mympd-script` is a small command line tool to execute myMPD scripts.

diff --git a/docs/scripting/widges.md → docs/050-scripting/widgets.md b/docs/scripting/widges.md → docs/050-scripting/widgets.md
@@ -1,7 +1,5 @@
 ---
-layout: page
-permalink: /scripting/widges
-title: Home screen widges
+title: Home screen widgets
 ---
 
 Scripts for home screen widges must return a valid http response. The response body will be inserted in the widget body.

diff --git a/docs/060-references/.pages b/docs/060-references/.pages
@@ -0,0 +1 @@
+title: References
diff --git a/docs/references/api/index.md → docs/060-references/api/index.md b/docs/references/api/index.md → docs/060-references/api/index.md
diff --git a/docs/references/api/methods.md → docs/060-references/api/methods.md b/docs/references/api/methods.md → docs/060-references/api/methods.md
diff --git a/docs/references/api/notifications.md → docs/060-references/api/notifications.md b/docs/references/api/notifications.md → docs/060-references/api/notifications.md
diff --git a/docs/references/components.md → docs/060-references/components.md b/docs/references/components.md → docs/060-references/components.md
diff --git a/docs/references/custom-navbar-icons.md → docs/060-references/custom-navbar-icons.md b/docs/references/custom-navbar-icons.md → docs/060-references/custom-navbar-icons.md
diff --git a/docs/references/feature-matrix.md → docs/060-references/feature-matrix.md b/docs/references/feature-matrix.md → docs/060-references/feature-matrix.md
diff --git a/docs/references/filesystem-hierarchy.md → docs/060-references/filesystem-hierarchy.md b/docs/references/filesystem-hierarchy.md → docs/060-references/filesystem-hierarchy.md
diff --git a/docs/060-references/index.md b/docs/060-references/index.md
@@ -0,0 +1,29 @@
+---
+layout: page
+permalink: /references/
+title: References
+---
+
+- [API Documentation](references/api/)
+- [Components](references/components)
+- [Custom navbar icons](references/custom-navbar-icons)
+- [Feature matrix](references/feature-matrix)
+- [Filesystem hierarchy](references/filesystem-hierarchy)
+- [Local playback](references/local-playback)
+- [Lyrics](references/lyrics)
+- [Partitions](references/partitions)
+- [Pictures](references/pictures)
+- [Published directories](references/published-directories)
+- [Smart playlists](references/smart-playlists)
+- [Sticker](references/sticker)
+- [Tags](references/tags)
+- [Translating](references/translating)
+- [Trigger](references/trigger)
+- [Webserver uris](references/webserver-uris)
+
+## Source documentation
+
+If you want to hack on myMPD:
+
+- [Backend API Documentation](/doxygen/html/index.html) &ndash; generated by [Doxygen](https://www.doxygen.nl/)
+- [Frontend API Documentation](/jsdoc/index.html) &ndash; generated by [JSDoc](https://jsdoc.app/)
diff --git a/docs/references/local-playback.md → docs/060-references/local-playback.md b/docs/references/local-playback.md → docs/060-references/local-playback.md
diff --git a/docs/references/lyrics.md → docs/060-references/lyrics.md b/docs/references/lyrics.md → docs/060-references/lyrics.md
diff --git a/docs/references/partitions.md → docs/060-references/partitions.md b/docs/references/partitions.md → docs/060-references/partitions.md
diff --git a/docs/references/pictures.md → docs/060-references/pictures.md b/docs/references/pictures.md → docs/060-references/pictures.md
diff --git a/docs/references/published-directories.md → docs/060-references/published-directories.md b/docs/references/published-directories.md → docs/060-references/published-directories.md
diff --git a/docs/references/smart-playlists.md → docs/060-references/smart-playlists.md b/docs/references/smart-playlists.md → docs/060-references/smart-playlists.md
diff --git a/docs/references/sticker.md → docs/060-references/sticker.md b/docs/references/sticker.md → docs/060-references/sticker.md
diff --git a/docs/references/tags.md → docs/060-references/tags.md b/docs/references/tags.md → docs/060-references/tags.md
diff --git a/docs/references/translating.md → docs/060-references/translating.md b/docs/references/translating.md → docs/060-references/translating.md
diff --git a/docs/references/translating_status.md → docs/060-references/translating_status.md b/docs/references/translating_status.md → docs/060-references/translating_status.md
diff --git a/docs/references/trigger.md → docs/060-references/trigger.md b/docs/references/trigger.md → docs/060-references/trigger.md
diff --git a/docs/references/webradios.md → docs/060-references/webradios.md b/docs/references/webradios.md → docs/060-references/webradios.md
diff --git a/docs/references/webserver-uris.md → docs/060-references/webserver-uris.md b/docs/references/webserver-uris.md → docs/060-references/webserver-uris.md
diff --git a/docs/070-additional-topics/.pages b/docs/070-additional-topics/.pages
@@ -0,0 +1 @@
+title: Additional topics
diff --git a/...ditional-topics/behind-a-reverse-proxy.md → ...ditional-topics/behind-a-reverse-proxy.md b/...ditional-topics/behind-a-reverse-proxy.md → ...ditional-topics/behind-a-reverse-proxy.md
diff --git a/docs/070-additional-topics/index.md b/docs/070-additional-topics/index.md
@@ -0,0 +1,13 @@
+---
+layout: page
+permalink: /additional-topics/
+title: Additional topics
+---
+
+Here can you find some examples for advanced configurations.
+
+- [Behind a reverse proxy](additional-topics/behind-a-reverse-proxy)
+- [Multiple myMPD instances on same host](additional-topics/multiple-myMPD-instances-on-same-host)
+- [Recommended MPD configuration](additional-topics/recommended-mpd-configuration)
+- [Multiroom audio system using MPD/myMPD and pulseaudio](additional-topics/multiroom-audio-using-pulseaudio-rtp)
+- [MPD satellite setup](additional-topics/mpd-satellite-setup)
diff --git a/.../additional-topics/mpd-satellite-setup.md → ...-additional-topics/mpd-satellite-setup.md b/.../additional-topics/mpd-satellite-setup.md → ...-additional-topics/mpd-satellite-setup.md
diff --git a/.../multiple-myMPD-instances-on-same-host.md → .../multiple-myMPD-instances-on-same-host.md b/.../multiple-myMPD-instances-on-same-host.md → .../multiple-myMPD-instances-on-same-host.md
diff --git a/...s/multiroom-audio-using-pulseaudio-rtp.md → ...s/multiroom-audio-using-pulseaudio-rtp.md b/...s/multiroom-audio-using-pulseaudio-rtp.md → ...s/multiroom-audio-using-pulseaudio-rtp.md
diff --git a/...l-topics/recommended-mpd-configuration.md → ...l-topics/recommended-mpd-configuration.md b/...l-topics/recommended-mpd-configuration.md → ...l-topics/recommended-mpd-configuration.md
diff --git a/docs/known-issues.md → docs/080-known-issues.md b/docs/known-issues.md → docs/080-known-issues.md
diff --git a/docs/security.md → docs/090-security.md b/docs/security.md → docs/090-security.md
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/_includes/breadcrumbs.md b/docs/_includes/breadcrumbs.md
diff --git a/docs/_includes/nav-additional-topics.html b/docs/_includes/nav-additional-topics.html
diff --git a/docs/_includes/nav-references.html b/docs/_includes/nav-references.html
diff --git a/docs/_includes/nav.html b/docs/_includes/nav.html
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
diff --git a/docs/additional-topics/index.md b/docs/additional-topics/index.md
diff --git a/docs/assets/css/bootstrap.min.css b/docs/assets/css/bootstrap.min.css
diff --git a/docs/assets/css/mympd.css b/docs/assets/css/mympd.css
@@ -0,0 +1,7 @@
+:root {
+    --md-primary-fg-color:        #28a745;
+    --md-primary-fg-color--light: #28a745;
+    --md-primary-fg-color--dark:  #28a745;
+    --md-accent-fg-color: #28a745;
+    --md-accent-fg-color--transparent: #28a745;
+}