Fix: links

docs/000-index.md

@@ -12,4 +12,3 @@ 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-markdown "_includes/version" %}.
-

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](installation/compiling/cmake) directly.
+With the `build.sh` script you can easily build myMPD and create your own packages. Downstream packagers should use [cmake](cmake.md) 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](installation/openwrt)
+- Build a [OpenWrt package](openwrt.md)
 
 ### Cross compiling debian packages
 

docs/010-installation/compiling/index.md

@@ -45,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](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)
+- [Easy build with the build.sh script](build-sh.md)
+- [Advanced build with cmake](cmake.md)
+- [Build it in Termux](termux.md)
+- [Build it for OpenWrt](openwrt.md)
+- [Build it for FreeBSD](freebsd.md)

docs/010-installation/docker.md

@@ -101,4 +101,4 @@ docker logs -f mympd
 
 You can configure some basic options of myMPD via startup options or environment variables.
 
-- [Configuration](configuration/)
+- [Configuration](../020-configuration/index.md)

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](installation/distributions)
-2. [Prebuild Packages](installation/prebuild-packages)
-3. [Docker](installation/docker)
-4. [Compiling myMPD](installation/compiling/)
+1. [Distributions with myMPD packages](distributions.md)
+2. [Prebuild Packages](prebuild-packages.md)
+3. [Docker](docker.md)
+4. [Compiling myMPD](compiling/index.md)
 
 ## Supported platforms
 
 - All current linux distributions (x86 and arm)
-- [FreeBSD](installation/compiling/freebsd)
-- [OpenWrt](installation/compiling/openwrt)
-- [Termux](installation/compiling/termux)
+- [FreeBSD](compiling/freebsd.md)
+- [OpenWrt](compiling/openwrt.md)
+- [Termux](compiling/termux.md)

docs/010-installation/prebuild-packages.md

@@ -13,7 +13,7 @@ Download the appropriated package for your distribution and install it with the
 Following distributions are supported:
 
 - Arch
-- [Debian](installation/prebuild-packages-debian)
+- [Debian](prebuild-packages-debian.md)
 - Fedora
 - Raspian
 - openSUSE

docs/020-configuration/configuration-files.md

@@ -15,7 +15,7 @@ You can use `mympd -c` to create the initial configuration in the `/var/lib/mymp
 
 **Note:**
 
-Use [systemd-run](running#manual-startup), if you use a distribution with systemd, e.g.:
+Use [systemd-run](../030-running.md#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
@@ -25,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](configuration/acl), allows all hosts in the default configuration |
+| acl | string | MYMPD_ACL | | ACL to access the myMPD webserver: [ACL](acl.md), 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. |
@@ -35,11 +35,11 @@ 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](configuration/logging) - this environment variable is always used |
+| loglevel | number | MYMPD_LOGLEVEL | 5 | [Logging](logging.md) - 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](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](acl.md), 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. |
@@ -57,4 +57,4 @@ systemd-run -p DynamicUser=yes -p StateDirectory=mympd -p CacheDirectory=mympd -
 | ssl_cert | string | MYMPD_SSL_CERT | | Path to custom ssl certificate file |
 | ssl_key | string | MYMPD_SSL_KEY | | Path to custom ssl key file |
 
-- More details on [SSL](configuration/ssl)
+- More details on [SSL](ssl.md)

docs/030-running.md

@@ -1,5 +1,4 @@
 ---
-
 title: Running
 ---
 
@@ -26,7 +25,6 @@ The installation process installs a LSB compatible startup script / systemd unit
 | systemd | `/usr/lib/systemd/system/mympd` or `/lib/systemd/system/mympd` |
 | sysVinit | `/etc/init.d/mympd` |
 
-
 ### Systemd usage
 
 You must enable and start the service manually. Use `systemctl enable mympd` to enable myMPD at startup and `systemctl start mympd` to start myMPD now.
@@ -60,14 +58,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](configuration/).
+Description of [Commandline-Options](020-configuration/index.md).
 
 ## Docker
 
-Goto [Docker](installation/docker)
+Goto [Docker](010-installation/docker.md)
 
 ## myMPD configuration
 
 You can configure some basic options of myMPD via startup options or environment variables.
 
-- [Configuration](configuration/)
+- [Configuration](020-configuration/index.md)

docs/040-debug.md

@@ -16,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](running#manual-startup), if you use a distribution with systemd
+- **Note:** Use [systemd-run](030-running.md#manual-startup), if you use a distribution with systemd
 
 ### Get logs from running myMPD
 

docs/050-scripting/functions/index.md

@@ -7,37 +7,37 @@ List of myMPD specific Lua functions.
 
 | FUNCTION | DESCRIPTION |
 | -------- | ----------- |
-| [json.decode](scripting/functions/json) | Parses a Json string to a Lua table. |
-| [json.encode](scripting/functions/json) | Encodes a Lua table as Json string. |
-| [mympd.api](scripting/functions/mympd_api) | Access to the myMPD API. |
-| [mympd.cache_cover_write](scripting/functions/diskcache) | Writes a cover cache file. |
-| [mympd.cache_lyrics_write](scripting/functions/diskcache) | Writes a lyrics cache file. |
-| [mympd.cache_thumbs_write](scripting/functions/diskcache) | Writes a thumbs cache file. |
-| [mympd.dialog](scripting/functions/mympd_dialog) | Returns an Jsonrpc response for a script dialog. |
-| [mympd.gpio_blink](scripting/functions/gpio) | Connects to myGPIOd and blinks a GPIO with given timeout and interval. |
-| [mympd.gpio_get](scripting/functions/gpio) | Connects to myGPIOd and returns the active state of a GPIO. |
-| [mympd.gpio_set](scripting/functions/gpio) | Connects to myGPIOd and sets the active value of a GPIO. |
-| [mympd.gpio_toggle](scripting/functions/gpio) | Connects to myGPIOd and toggles the active value of a GPIO. |
-| [mympd.hash_md5](scripting/functions/util) | MD5 hash of string. |
-| [mympd.hash_sha1](scripting/functions/util) | SHA1 hash of string. |
-| [mympd.hash_sha256](scripting/functions/util) | SHA256 hash of string. |
-| [mympd.htmlencode](scripting/functions/util) | Simple HTML encoding. |
-| [mympd.http_client](scripting/functions/http_client) | Simple HTTP client. |
-| [mympd.http_download](scripting/functions/http_client) | Download a file over http. |
-| [mympd.http_jsonrpc_error](scripting/functions/http_replies) | Sends a JSONRPC 2.0 error. |
-| [mympd.http_jsonrpc_response](scripting/functions/http_replies) | Sends a JSONRPC 2.0 response. |
-| [mympd.http_jsonrpc_warn](scripting/functions/http_replies) | Sends a JSONRPC 2.0 warning. |
-| [mympd.http_redirect](scripting/functions/http_replies) | Returns a valid HTTP redirect message. |
-| [mympd.http_reply](scripting/functions/http_replies) | Returns a valid HTTP response message. |
-| [mympd.http_serve_file](scripting/functions/http_replies) | Serves a file from the filesystem. Only files from the diskcache are allowed. |
-| [mympd.init](scripting/functions/mympd_init) | Initializes the Lua table mympd_state. |
-| [mympd.log](scripting/functions/util) | Logging to myMPD log. |
-| [mympd.notify_client](scripting/functions/util) | Sends a notification to the client. |
-| [mympd.notify_partition](scripting/functions/util) | Sends a notification to all clients in a partition. |
-| [mympd.os_capture](scripting/functions/system_command) | Executes a system command and capture its output. |
-| [mympd.tmp_file](scripting/functions/diskcache) | Generates a random tmp filename for the misc cache. |
-| [mympd.update_mtime](scripting/functions/diskcache) | Updates the timestamp of a file. |
-| [mympd.urldecode](scripting/functions/util) | Decodes a URL encoded string. |
-| [mympd.urlencode](scripting/functions/util) | URL encodes a string. |
+| [json.decode](json.md) | Parses a Json string to a Lua table. |
+| [json.encode](json.md) | Encodes a Lua table as Json string. |
+| [mympd.api](mympd_api.md) | Access to the myMPD API. |
+| [mympd.cache_cover_write](diskcache.md) | Writes a cover cache file. |
+| [mympd.cache_lyrics_write](diskcache.md) | Writes a lyrics cache file. |
+| [mympd.cache_thumbs_write](diskcache.md) | Writes a thumbs cache file. |
+| [mympd.dialog](mympd_dialog.md) | Returns an Jsonrpc response for a script dialog. |
+| [mympd.gpio_blink](gpio.md) | Connects to myGPIOd and blinks a GPIO with given timeout and interval. |
+| [mympd.gpio_get](gpio.md) | Connects to myGPIOd and returns the active state of a GPIO. |
+| [mympd.gpio_set](gpio.md) | Connects to myGPIOd and sets the active value of a GPIO. |
+| [mympd.gpio_toggle](gpio.md) | Connects to myGPIOd and toggles the active value of a GPIO. |
+| [mympd.hash_md5](util.md) | MD5 hash of string. |
+| [mympd.hash_sha1](util.md) | SHA1 hash of string. |
+| [mympd.hash_sha256](util.md) | SHA256 hash of string. |
+| [mympd.htmlencode](util.md) | Simple HTML encoding. |
+| [mympd.http_client](http_client.md) | Simple HTTP client. |
+| [mympd.http_download](http_client.md) | Download a file over http. |
+| [mympd.http_jsonrpc_error](http_replies.md) | Sends a JSONRPC 2.0 error. |
+| [mympd.http_jsonrpc_response](http_replies.md) | Sends a JSONRPC 2.0 response. |
+| [mympd.http_jsonrpc_warn](http_replies.md) | Sends a JSONRPC 2.0 warning. |
+| [mympd.http_redirect](http_replies.md) | Returns a valid HTTP redirect message. |
+| [mympd.http_reply](http_replies.md) | Returns a valid HTTP response message. |
+| [mympd.http_serve_file](http_replies.md) | Serves a file from the filesystem. Only files from the diskcache are allowed. |
+| [mympd.init](mympd_init.md) | Initializes the Lua table mympd_state. |
+| [mympd.log](util.md) | Logging to myMPD log. |
+| [mympd.notify_client](util.md) | Sends a notification to the client. |
+| [mympd.notify_partition](util.md) | Sends a notification to all clients in a partition. |
+| [mympd.os_capture](system_command.md) | Executes a system command and capture its output. |
+| [mympd.tmp_file](diskcache.md) | Generates a random tmp filename for the misc cache. |
+| [mympd.update_mtime](diskcache.md) | Updates the timestamp of a file. |
+| [mympd.urldecode](util.md) | Decodes a URL encoded string. |
+| [mympd.urlencode](util.md) | URL encodes a string. |
 
-- [LuaDoc](luadoc/files/debug/contrib/lualibs/mympd.html)
+- [LuaDoc](../../luadoc/files/debug/contrib/lualibs/mympd.html)

docs/050-scripting/functions/mympd_api.md

@@ -3,7 +3,7 @@
 title: Accessing the myMPD API
 ---
 
-Calls the myMPD API, look at [API](references/api/) for detailed API description.
+Calls the myMPD API, look at [API](../../060-references/api/index.md) for detailed API description.
 
 ```lua
 local rc, result = mympd.api("method", params)

docs/050-scripting/index.md

@@ -7,11 +7,11 @@ myMPD integrates [Lua](http://www.lua.org) for scripting purposes. Scripts are e
 
 The first type of scripts are executed by triggers, timers or manual through the web ui. The script output is printed to STDOUT and the return value is broadcasted to all connected clients in the current partition.
 
-- [Triggers](references/trigger)
+- [Triggers](../060-references/trigger.md)
 
 The second type of script are called by http requests (`/script/<partition>/<script>`), special triggers and home screen widgets. This scripts should return a valid http response including status code, headers and body.
 
-- [Widgets](scripting/widges)
+- [Widgets](widgets.md)
 
 ## Global variables
 
@@ -63,13 +63,13 @@ Arguments can be defined as simple names (text input field) or with typical html
 
 The mympd_state global lua table is NOT populates automatically. You must call `mympd.init()` to populate it.
 
-- [mympd.init](scripting/functions/mympd_init)
+- [mympd.init](functions/mympd_init.md)
 
 ## Custom myMPD lua functions
 
 myMPD provides custom lua functions through the `mympd` and `json` lua library.
 
-- [List of all functions](scripting/functions/)
+- [List of all functions](functions/index.md)
 
 ## Lua manual
 
@@ -134,4 +134,3 @@ return("Arguments are: " .. mympd_arguments.testarg1 .. mympd_arguments.testarg2
 | desc | A short description. |
 | order | Sort order of the script, 0 disables listing in main menu. |
 | arguments | Name of the keys for the script arguments, the gui asks for this arguments. Arguments are populated in a lua table called `mympd_arguments`. |
-

docs/050-scripting/widgets.md

@@ -6,7 +6,7 @@ Scripts for home screen widges must return a valid http response. The response b
 
 You can style the widget with all [Bootstrap classes](https://getbootstrap.com/), inline css is forbidden.
 
-Inline JavaScript is also forbidden, but you can call all available [functions](jsdoc/index.html).
+Inline JavaScript is also forbidden, but you can call all available [functions](../jsdoc/index.html).
 
 ## Skeleton for a widget script
 

docs/060-references/api/index.md

@@ -18,13 +18,13 @@ The websocket connection registers the Client ID on the webserver. This registra
 
 **API endpoint:** `/api/<partition>`
 
-- [API reference](references/api/methods)
+- [API reference](methods.md)
 
 Notifications from the backend to the frontend are sent over a websocket connection.
 
 **Websocket endpoint:** `/ws/<partition>`
 
-- [Notification reference](references/api/notifications)
+- [Notification reference](notifications.md)
 
 ## Example API calls
 

docs/060-references/index.md

@@ -3,26 +3,26 @@
 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)
+- [API Documentation](api/index.md)
+- [Components](components.md)
+- [Custom navbar icons](custom-navbar-icons.md)
+- [Feature matrix](feature-matrix.md)
+- [Filesystem hierarchy](filesystem-hierarchy.md)
+- [Local playback](local-playback.md)
+- [Lyrics](lyrics.md)
+- [Partitions](partitions.md)
+- [Pictures](pictures.md)
+- [Published directories](published-directories.md)
+- [Smart playlists](smart-playlists.md)
+- [Sticker](sticker.md)
+- [Tags](tags.md)
+- [Translating](translating.md)
+- [Trigger](trigger.md)
+- [Webserver uris](webserver-uris.md)
 
 ## Source documentation
 
 If you want to hack on myMPD:
 
-- [Backend API Documentation](/doxygen/html/index.html) – generated by [Doxygen](https://www.doxygen.nl/)
-- [Frontend API Documentation](/jsdoc/index.html) – generated by [JSDoc](https://jsdoc.app/)
+- [Backend API Documentation](../doxygen/html/index.html) – generated by [Doxygen](https://www.doxygen.nl/)
+- [Frontend API Documentation](../jsdoc/index.html) – generated by [JSDoc](https://jsdoc.app/)

docs/060-references/smart-playlists.md

@@ -16,7 +16,7 @@ Smart playlists are saved in the folder `/var/lib/mympd/smartpls` (one JSON file
 | KEY | TYPE | DESCRIPTION |
 | --- | ---- | ----------- |
 | type | all | Type of smart playlist: `sticker`, `newest` or `search` |
-| sticker | sticker | Stickername, see [Sticker](references/sticker) |
+| sticker | sticker | Stickername, see [Sticker](sticker.md) |
 | value | sticker | Sticker value |
 | op | sticker | Sticker compare operator: `=`, `<`, `>`, `gt` (MPD 0.24), `lt` (MPD 0.24) |
 | timerange | newest | Timerange since last database update in seconds |

docs/060-references/sticker.md

@@ -34,4 +34,4 @@ Run `mympd-config MYMPD_STICKERS_PAD_INT true` and restart myMPD.
 
 myMPD uses a distinct mpd connection to read and write stickers. You can configure this connection to use an other mpd server to maintain song statistics across several myMPD instances.
 
-- [MPD satellite setup](additional-topics/mpd-satellite-setup.md)
+- [MPD satellite setup](../070-additional-topics/mpd-satellite-setup.md)

docs/060-references/translating.md

@@ -12,7 +12,7 @@ Following translations are available and maintained:
 
 User contributed translations:
 
-{% include_relative translating_status.md %}
+{% include-markdown "../_includes/translating_status.md" %}
 
 Translations with more than 100 missing phrases are not included in the build.
 

docs/060-references/webserver-uris.md

@@ -13,7 +13,7 @@ Reference of all webserver uris.
 | `/albumart?offset=<nr>&uri=<songuri>` | Returns the albumart, offset should be 0 and is only relevant to retrieve more than the first embedded image. |
 | `/albumart-thumb?offset=<nr>&uri=<songuri>` | Returns the albumart thumbnail, offset should be 0 |
 | `/api/<partition>` | jsonrpc api endpoint |
-| `/browse/` | Prints the list of [published directories](references/published-directories) |
+| `/browse/` | Prints the list of [published directories](published-directories.md) |
 | `/ca.crt` | Returns the myMPD CA certificate |
 | `/folderart?path=<path>` | Returns the folderart thumbnail. |
 | `/playlistart?type=<plist,smartpls>&playlist=<playlist name>` | Returns the playlistart thumbnail or a redirect to the placeholder image if not found. |