Upd: remove jekyll specifica

jcorporation · Sep 22, 2024 · 18f86ba · 18f86ba
1 parent e1fc2d4
commit 18f86ba
Show file tree

Hide file tree

Showing 62 changed files with 163 additions and 258 deletions.
diff --git a/docs/000-index.md b/docs/000-index.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /
+
 title: myMPD Documentation
 ---
 

diff --git a/docs/010-installation/compiling/build-sh.md b/docs/010-installation/compiling/build-sh.md
@@ -2,7 +2,7 @@
 title: Compiling with build.sh
 ---
 
-With the `build.sh` script you can easily build myMPD and create your own packages. Downstream packagers should use [cmake]({{ site.baseurl }}/installation/compiling/cmake) directly.
+With the `build.sh` script you can easily build myMPD and create your own packages. Downstream packagers should use [cmake](installation/compiling/cmake) directly.
 
 ## Compiling and installing
 
@@ -53,7 +53,7 @@ You can self create packages for your distribution:
 - `./build.sh pkgrpm` for RPM based distributions (e.g. openSUSE, Fedora)
 - `./build.sh pkgdocker` to create a Docker image based on Alpine Linux
 - For gentoo you have to create a local overlay: https://wiki.gentoo.org/wiki/Custom_repository, the ebuild file is in the directory `contrib/packaging/gentoo`
-- Build a [OpenWrt package]({{ site.baseurl }}/installation/openwrt)
+- Build a [OpenWrt package](installation/openwrt)
 
 ### Cross compiling debian packages
 

diff --git a/docs/010-installation/compiling/index.md b/docs/010-installation/compiling/index.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /installation/compiling/
+
 title: Compiling
 ---
 
@@ -12,7 +11,6 @@ title: Compiling
 | [master](https://github.com/jcorporation/myMPD/tree/master) | stable | the latest releas is created from the master branch |
 | [devel](https://github.com/jcorporation/myMPD/tree/devel) | unstable | this branch is for the next bugfix release |
 | other branches | unstable | development branches for new major and minor releases |
-{: .table .table-sm }
 
 Get the appropriated tarball or clone the git repository and checkout the wanted branch.
 
@@ -47,8 +45,8 @@ You can type `./build.sh installdeps` as root to install the dependencies (works
 
 ## Building myMPD
 
-- [Easy build with the build.sh script]({{ site.baseurl }}/installation/compiling/build-sh)
-- [Advanced build with cmake]({{ site.baseurl }}/installation/compiling/cmake)
-- [Build it in Termux]({{ site.baseurl }}/installation/compiling/termux)
-- [Build it for OpenWrt]({{ site.baseurl }}/installation/compiling/openwrt)
-- [Build it for FreeBSD]({{ site.baseurl }}/installation/compiling/freebsd)
+- [Easy build with the build.sh script](installation/compiling/build-sh)
+- [Advanced build with cmake](installation/compiling/cmake)
+- [Build it in Termux](installation/compiling/termux)
+- [Build it for OpenWrt](installation/compiling/openwrt)
+- [Build it for FreeBSD](installation/compiling/freebsd)
diff --git a/docs/010-installation/compiling/openwrt.md b/docs/010-installation/compiling/openwrt.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /installation/compiling/openwrt
+
 title: OpenWrt
 ---
 

diff --git a/docs/010-installation/compiling/termux.md b/docs/010-installation/compiling/termux.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /installation/compiling/termux
+
 title: Termux
 ---
 

diff --git a/docs/010-installation/distributions.md b/docs/010-installation/distributions.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /installation/distributions
+
 title: Distributions
 ---
 

diff --git a/docs/010-installation/docker.md b/docs/010-installation/docker.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /installation/docker
+
 title: Docker
 ---
 
@@ -38,7 +37,7 @@ Starts the myMPD docker container:
 | `/docker/mympd/cachedir` | myMPD cache directory. Must exist and be writeable by uid 1000. |
 | `/var/lib/mpd/music/` | MPD music directory. Use the same path in the container to enable auto detection. |
 | `/var/lib/mpd/playlists/` | MPD playlist directory. Use the same path in the container to enable auto detection. |
-{: .table .table-sm}
+
 
 You must create the `cachedir` and `workdir` before starting the container.
 
@@ -102,4 +101,4 @@ docker logs -f mympd
 
 You can configure some basic options of myMPD via startup options or environment variables.
 
-- [Configuration]({{ site.baseurl }}/configuration/)
+- [Configuration](configuration/)
diff --git a/docs/010-installation/index.md b/docs/010-installation/index.md
@@ -4,14 +4,14 @@ title: Installation
 
 myMPD should run on all current linux distributions. There are four ways to install myMPD:
 
-1. [Distributions with myMPD packages]({{ site.baseurl }}/installation/distributions)
-2. [Prebuild Packages]({{ site.baseurl }}/installation/prebuild-packages)
-3. [Docker]({{ site.baseurl }}/installation/docker)
-4. [Compiling myMPD]({{ site.baseurl }}/installation/compiling/)
+1. [Distributions with myMPD packages](installation/distributions)
+2. [Prebuild Packages](installation/prebuild-packages)
+3. [Docker](installation/docker)
+4. [Compiling myMPD](installation/compiling/)
 
 ## Supported platforms
 
 - All current linux distributions (x86 and arm)
-- [FreeBSD]({{ site.baseurl }}/installation/compiling/freebsd)
-- [OpenWrt]({{ site.baseurl }}/installation/compiling/openwrt)
-- [Termux]({{ site.baseurl }}/installation/compiling/termux)
+- [FreeBSD](installation/compiling/freebsd)
+- [OpenWrt](installation/compiling/openwrt)
+- [Termux](installation/compiling/termux)
diff --git a/docs/010-installation/prebuild-packages-debian.md b/docs/010-installation/prebuild-packages-debian.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /installation/prebuild-packages-debian
+
 title: Debian Installation
 ---
 

diff --git a/docs/010-installation/prebuild-packages.md b/docs/010-installation/prebuild-packages.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /installation/prebuild-packages
+
 title: Prebuild packages
 ---
 
@@ -14,7 +13,7 @@ Download the appropriated package for your distribution and install it with the
 Following distributions are supported:
 
 - Arch
-- [Debian]({{ site.baseurl }}/installation/prebuild-packages-debian)
+- [Debian](installation/prebuild-packages-debian)
 - Fedora
 - Raspian
 - openSUSE

diff --git a/docs/020-configuration/acl.md b/docs/020-configuration/acl.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /configuration/acl
+
 title: ACL
 ---
 
@@ -21,4 +20,4 @@ ACLs for IPv6 are currently not supported.
 | `+0.0.0.0/0`| Allow all |
 | `+127.0.0.0/8`| Allow localhost |
 | `+127.0.0.0/8,+192.168.0.0/24` | Allow localhost and all hosts in the net 192.168.0.x |
-{: .table .table-sm}
+
diff --git a/docs/020-configuration/command-line-options.md b/docs/020-configuration/command-line-options.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /configuration/command-line-options
+
 title: Command line options
 ---
 
@@ -18,4 +17,4 @@ The `workdir` and `cachedir` options are useful if you want to run more then one
 | `-w`, `--workdir <path>` | working directory (default: `/var/lib/mympd`). This folder must exist, if not started as root. |
 | `-a`, `--cachedir <path>` | cache directory (default: `/var/cache/mympd`). This folder must exist, if not started as root. |
 | `-p`, `--pin` | sets a pin for myMPD settings |
-{: .table .table-sm }
+
diff --git a/docs/020-configuration/configuration-files.md b/docs/020-configuration/configuration-files.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /configuration/configuration-files
+
 title: Configuration files
 ---
 
@@ -16,7 +15,7 @@ You can use `mympd -c` to create the initial configuration in the `/var/lib/mymp
 
 **Note:**
 
-Use [systemd-run]({{ site.baseurl }}/running#manual-startup), if you use a distribution with systemd, e.g.:
+Use [systemd-run](running#manual-startup), if you use a distribution with systemd, e.g.:
 
 ```sh
 systemd-run -p DynamicUser=yes -p StateDirectory=mympd -p CacheDirectory=mympd -E MYMPD_LOGLEVEL=4 -E MYMPD_HTTP=false -E MYMPD_SSL_PORT=1333 mympd -c
@@ -26,7 +25,7 @@ systemd-run -p DynamicUser=yes -p StateDirectory=mympd -p CacheDirectory=mympd -
 
 | FILE | TYPE | ENVIRONMENT | DEFAULT | DESCRIPTION |
 | ---- | ---- | ----------- | ------- | ----------- |
-| acl | string | MYMPD_ACL | | ACL to access the myMPD webserver: [ACL]({{ site.baseurl }}/configuration/acl), allows all hosts in the default configuration |
+| acl | string | MYMPD_ACL | | ACL to access the myMPD webserver: [ACL](configuration/acl), allows all hosts in the default configuration |
 | album_group_tag | string | MYMPD_ALBUM_GROUP_TAG | Date | Additional tag to group albums |
 | album_mode | string | MYMPD_ALBUM_MODE | adv | Set the album mode: `adv` or `simple` |
 | cache_cover_keep_days | number | MYMPD_CACHE_COVER_KEEP_DAYS | 31 | How long to keep images in the cover cache; 0 to disable the cache; -1 to disable pruning of the cache. |
@@ -36,15 +35,14 @@ systemd-run -p DynamicUser=yes -p StateDirectory=mympd -p CacheDirectory=mympd -
 | http | boolean | MYMPD_HTTP | true | `true` = Enable listening on http_port |
 | http_host | string | MYMPD_HTTP_HOST | `[::]` | IP address to listen on, use `[::]` to listen on IPv6 and IPv4 |
 | http_port | number | MYMPD_HTTP_PORT | 80 | Port to listen for plain http requests. Redirects to `ssl_port` if `ssl` is set to `true`. *1 |
-| loglevel | number | MYMPD_LOGLEVEL | 5 | [Logging]({{ site.baseurl }}/configuration/logging) - this environment variable is always used |
+| loglevel | number | MYMPD_LOGLEVEL | 5 | [Logging](configuration/logging) - this environment variable is always used |
 | mympd_uri | string | MYMPD_URI | auto | `auto` or uri to myMPD listening port, e.g. `https://192.168.1.1/mympd` |
 | pin_hash | string | N/A | | SHA256 hash of pin, create it with `mympd -p` |
 | save_caches | boolean | MYMPD_SAVE_CACHES | true | `true` = saves caches between restart, `false` = create caches on startup |
-| scriptacl | string | MYMPD_SCRIPTACL | +127.0.0.1 | ACL to access the myMPD script backend: [ACL]({{ site.baseurl }}/configuration/acl), allows only local connections in the default configuration. The acl above must also grant access. |
+| scriptacl | string | MYMPD_SCRIPTACL | +127.0.0.1 | ACL to access the myMPD script backend: [ACL](configuration/acl), allows only local connections in the default configuration. The acl above must also grant access. |
 | stickers | boolean | MYMPD_STICKERS | true | Enables the support for MPD stickers. |
 | stickers_pad_int | boolean | MYMPD_STICKERS_PAD_INT | false | Enables the padding of integer sticker values (12 digits). |
 | webradiodb | boolean | MYMPD_WEBRADIODB | true | Enables the WebradioDB integration. |
-{: .table .table-sm }
 
 1. If http_port is disabled: The MPD curl plugin must trust the myMPD CA or certificate checking must be disabled. MPD fetches webradio playlists with http(s) from myMPD webserver.
 
@@ -58,6 +56,5 @@ systemd-run -p DynamicUser=yes -p StateDirectory=mympd -p CacheDirectory=mympd -
 | custom_cert | boolean | MYMPD_CUSTOM_CERT | false | `true` = use custom ssl key and certificate |
 | ssl_cert | string | MYMPD_SSL_CERT | | Path to custom ssl certificate file |
 | ssl_key | string | MYMPD_SSL_KEY | | Path to custom ssl key file |
-{: .table .table-sm }
 
-- More details on [SSL]({{ site.baseurl }}/configuration/ssl)
+- More details on [SSL](configuration/ssl)
diff --git a/docs/020-configuration/index.md b/docs/020-configuration/index.md
@@ -1,23 +1,22 @@
 ---
-layout: page
-permalink: /configuration/
+
 title: Configuration
 ---
 
 myMPD has no single configuration file. Most of the options are configurable through the web-ui.
 
 There are some command line options to define basic settings, for example the working directory.
 
-- <a href="{{site.baseurl}}/configuration/command-line-options">Command line options</a>
+- <a href="command-line-options">Command line options</a>
 
 myMPD populates at first startup the default configuration files. You can configure this files with the `mympd-config` utility.
 
-- <a href="{{site.baseurl}}/configuration/configuration-files">Configuration files</a>
-- <a href="{{site.baseurl}}/configuration/mpd-connection">MPD connection</a>
+- <a href="configuration-files">Configuration files</a>
+- <a href="mpd-connection">MPD connection</a>
 
 Other setting that are not configurable in the web-ui:
 
-- <a href="{{site.baseurl}}/configuration/acl">ACL</a>
-- <a href="{{site.baseurl}}/configuration/logging">Logging</a>
-- <a href="{{site.baseurl}}/configuration/ssl">SSL</a>
-- <a href="{{site.baseurl}}/configuration/pin-protection">Pin protection</a>
+- <a href="acl">ACL</a>
+- <a href="logging">Logging</a>
+- <a href="ssl">SSL</a>
+- <a href="pin-protection">Pin protection</a>
diff --git a/docs/020-configuration/logging.md b/docs/020-configuration/logging.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /configuration/logging
+
 title: Logging
 ---
 
@@ -18,6 +17,6 @@ The log levels are unix default.
 | 5 | notice (default) |
 | 6 | info |
 | 7 | debug |
-{: .table .table-sm}
+
 
 If you want to start myMPD with a different loglevel as configured you can set the `MYMPD_LOGLEVEL` environment variable accordingly.
diff --git a/docs/020-configuration/mpd-connection.md b/docs/020-configuration/mpd-connection.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /configuration/mpd-connection
+
 title: MPD connection
 ---
 
@@ -13,7 +12,7 @@ The mpd connection settings can be configured in the web-ui (Main menu -> MPD co
 | MPD host | `/run/mpd/socket` |
 | MPD port | 6600 |
 | MPD timeout | 30 |
-{: .table .table-sm}
+
 
 ### MPD autodetection
 
@@ -32,6 +31,6 @@ myMPD tries to autodetect the mpd connection only at first start (if no mpd_host
 | MPD_HOST | MPD host or path to mpd socket |
 | MPD_PORT | MPD port |
 | MPD_TIMEOUT | MPD timeout in seconds |
-{: .table .table-sm}
+
 
 This is done after dropping privileges to the mympd user.
diff --git a/docs/020-configuration/pin-protection.md b/docs/020-configuration/pin-protection.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /configuration/pin-protection
+
 title: Pin protection
 ---
 
@@ -14,4 +13,4 @@ You can goto the main menu and login to create a session, press `L` or simply ta
 
 The session is valid until restart of myMPD, closing the browser, refreshing the site or you logout.
 
-The <a href="{{site.baseurl}}/references/api/methods">API documentation</a> shows whether a method is protected or not.
+The <a href="references/api/methods">API documentation</a> shows whether a method is protected or not.
diff --git a/docs/020-configuration/ssl.md b/docs/020-configuration/ssl.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /configuration/ssl
+
 title: SSL
 ---
 
@@ -23,7 +22,7 @@ The default certificates are saved in the directory `/var/lib/mympd/ssl/`.
 | ca.key | CA private key |
 | server.pem | Server certificate |
 | server.key | Server private key |
-{: .table .table-sm}
+
 
 The server certificates SAN is:
 
@@ -55,4 +54,4 @@ You can of course use your own certificate, e.g. from [Let's Encrypt](https://le
 | custom_cert | true |
 | ssl_key | path to custom ssl key |
 | ssl_cert | path to custom ssl certificate |
-{: .table .table-sm}
+
diff --git a/docs/030-running.md b/docs/030-running.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /running
+
 title: Running
 ---
 
@@ -26,7 +25,7 @@ The installation process installs a LSB compatible startup script / systemd unit
 | open-rc | `/etc/init.d/mympd` |
 | systemd | `/usr/lib/systemd/system/mympd` or `/lib/systemd/system/mympd` |
 | sysVinit | `/etc/init.d/mympd` |
-{: .table .table-sm}
+
 
 ### Systemd usage
 
@@ -61,14 +60,14 @@ If you use a distribution with systemd (without a static mympd user):
 systemd-run -t -p DynamicUser=yes -p StateDirectory=mympd -p CacheDirectory=mympd /usr/bin/mympd
 ```
 
-Description of [Commandline-Options]({{ site.baseurl }}/configuration/).
+Description of [Commandline-Options](configuration/).
 
 ## Docker
 
-Goto [Docker]({{ site.baseurl }}/installation/docker)
+Goto [Docker](installation/docker)
 
 ## myMPD configuration
 
 You can configure some basic options of myMPD via startup options or environment variables.
 
-- [Configuration]({{ site.baseurl }}/configuration/)
+- [Configuration](configuration/)
diff --git a/docs/040-debug.md b/docs/040-debug.md
@@ -1,6 +1,5 @@
 ---
-layout: page
-permalink: /debug
+
 title: Debug
 ---
 
@@ -17,7 +16,7 @@ Tips to debug problems with myMPD. Try these steps and reproduce the error.
 - Press Ctrl + C to abort
 - Reset loglevel: `unset MYMPD_LOGLEVEL`
 
-- **Note:** Use [systemd-run]({{ site.baseurl }}/running#manual-startup), if you use a distribution with systemd
+- **Note:** Use [systemd-run](running#manual-startup), if you use a distribution with systemd
 
 ### Get logs from running myMPD