mkdoc-isms

FAQ.md

@@ -95,9 +95,8 @@ You have a few options as noted below. Options 1 is short-term, while option 2 i
         sudo dpkg -i libseccomp2_2.4.4-1~bpo10+1_armhf.deb
         ```
 
-    {% hint style="info" %}
+        !!! info
             This url may have been updated. Find the latest by browsing [here](http://ftp.us.debian.org/debian/pool/main/libs/libseccomp/).
-    {% endhint %}
 
     - Option 2
 
@@ -117,9 +116,8 @@ You have a few options as noted below. Options 1 is short-term, while option 2 i
         - Any distro based on DebianStretch does not seem to have this package available
         - DebianBuster based distros can get the package trough backports, as outlined in point 2.
 
-    {% hint style="info" %}
+        !!! info
             RaspberryPI OS (formerly Raspbian) Can be upgraded to run with a 64bit kernel
-    {% endhint %}
 
 - Symptoms
 
@@ -140,7 +138,9 @@ Some host file systems types are not compatible with the default storage driver
     ```text
     ERROR Found no accessible config files
     ```
+
     or
+
     ```text
     Directory not empty. This directory contains an empty ignorecommands sub-directory
     ```
@@ -174,7 +174,7 @@ Alternatively, you can use Docker Hub or GHCR directly to pull your images, alth
 
 If Scarf is on the blocklist, you will get an error message like this when trying to pull an image:
 
-```
+```text
 Error response from daemon: Get "https://lscr.io/v2/": dial tcp: lookup lscr.io: no such host
 ```
 

docs/general/container-customization.md

@@ -14,7 +14,8 @@ All of the functionality described in this post is live on every one of the cont
 
 <https://fleet.linuxserver.io>
 
-**NOTE:** While the following support has been added to our containers, we will not give support to any custom scripts, services, or mods. If you are having an issue with one of our containers, be sure to disable all custom scripts/services/mods before seeking support.
+!!! note
+    While the following support has been added to our containers, we will not give support to any custom scripts, services, or mods. If you are having an issue with one of our containers, be sure to disable all custom scripts/services/mods before seeking support.
 
 ## Custom Scripts
 
@@ -41,7 +42,8 @@ echo "**** installing ffmpeg ****"
 apk add --no-cache ffmpeg
 ```
 
-**NOTE:** The folder `/custom-cont-init.d` needs to be owned by root! If this is not the case, this folder will be renamed and a new (empty) folder will be created. This is to prevent remote code execution by putting scripts in the aforementioned folder.
+!!! note
+    The folder `/custom-cont-init.d` needs to be owned by root! If this is not the case, this folder will be renamed and a new (empty) folder will be created. This is to prevent remote code execution by putting scripts in the aforementioned folder.
 
 ## Custom Services
 
@@ -65,9 +67,11 @@ Running cron in our containers is now as simple as a single file. Drop this scri
 /usr/sbin/crond -f -S -l 0 -c /etc/crontabs
 ```
 
-**NOTE:** With this example, you will most likely need to have cron installed via a custom script using the technique in the previous section, and will need to populate the crontab.
+!!! note
+    With this example, you will most likely need to have cron installed via a custom script using the technique in the previous section, and will need to populate the crontab.
 
-**NOTE:** The folder `/custom-services.d` needs to be owned by root! If this is not the case, this folder will be renamed and a new (empty) folder will be created. This is to prevent remote code execution by putting scripts in the aforementioned folder.
+!!! note
+    The folder `/custom-services.d` needs to be owned by root! If this is not the case, this folder will be renamed and a new (empty) folder will be created. This is to prevent remote code execution by putting scripts in the aforementioned folder.
 
 ## Docker Mods
 
@@ -106,7 +110,8 @@ docker create \
 
 The source code for this mod can be found [here](https://github.com/Taisun-Docker/config-mods/tree/master/pia).
 
-**NOTE:** When pulling in logic from external sources practice caution and trust the sources/community you get them from, as there are extreme security implications to consuming files from sources outside of our control.
+!!! note
+    When pulling in logic from external sources practice caution and trust the sources/community you get them from, as there are extreme security implications to consuming files from sources outside of our control.
 
 ## We are here to help
 

docs/general/docker-compose.md

@@ -8,7 +8,7 @@ Note that when inputting data for variables, you must follow standard YAML rules
 
 ## Installation
 
-- Install Option 1 (recommended)
+### Option 1 (recommended)
 
 Starting with version 2, Docker started publishing `docker compose` as a go based plugin for docker (rather than a python based standalone binary). And they also publish this plugin for various arches, including x86_64, armhf and aarch64 (as opposed to the x86_64 only binaries for v1.X). Therefore we updated our recommended install option to utilize the plugin.
 
@@ -19,7 +19,7 @@ Note that when inputting data for variables, you must follow standard YAML rules
 sh get-docker.sh
 ```
 
-- Install Option 2 (manual)
+### Option 2 (manual)
 
 You can install `docker compose` manually via the following commands:
 
@@ -39,11 +39,11 @@ Note that when inputting data for variables, you must follow standard YAML rules
 sh get-docker.sh
 ```
 
-  - v1.X compatibility
+#### v1.X compatibility
 
 As v2 runs as a plugin instead of a standalone binary, it is invoked by `docker compose args` instead of `docker-compose args`. There are also some slight differences in how the yaml is operated as well. To make migration easier, Docker released a replacement binary for `docker-compose` on x86_64 and aarch64 platforms. More info on that can be found at the [upstream repo](https://github.com/docker/compose-switch).
 
-- Install Option 3 (docker)
+### Option 3 (docker)
 
 You can install docker-compose using our [docker-compose image](https://github.com/linuxserver/docker-docker-compose) via a run script. You can simply run the following commands on your system and you should have a functional install that you can call from anywhere as `docker-compose`:
 

docs/general/fleet.md

@@ -108,15 +108,13 @@ All synchronized repositories and images returned.
 {% endapi-method-spec %}
 {% endapi-method %}
 
-{% hint style="info" %}
+!!! info
     Any repositories not synchronized with Docker Hub \(e.g. staging or metadata repositories\) will not be returned as part of the API. This also applies to images which the repository owner does not wish to be part of the primary image list.
-{% endhint %}
 
 ## Running Fleet
 
-{% hint style="warning" %}
+!!! warning
     Fleet is a Java application and requires at least JRE 11.
-{% endhint %}
 
 Grab the latest Fleet release from [GitHub](https://github.com/linuxserver/fleet/releases).
 
@@ -152,9 +150,8 @@ fleet.admin.secret=<a_random_string>
 
 All configuration can be loaded either via the config file, via JVM arguments, or via the system environment. Fleet will first look in the configuration file, then JVM runtime, and finally in the system environment. It will load the first value it finds, which can be useful when needing to override specific properties.
 
-{% hint style="info" %}
+!!! info
     If you place a property in the system environment, ensure that the property uses underscores rather than periods. This is due to a limitation in BASH environments where exported variables must not contain this character. E.g. `fleet.app.port=8080` becomes `export fleet_app_port=8080`
-{% endhint %}
 
 | Property Name | Purpose |
 | :--- | :--- |
@@ -169,9 +166,8 @@ If you place a property in the system environment, ensure that the property uses
 
 As well as the base configuration file, Fleet also supports some runtime arguments by means of the `-D` flag. These can be used to direct Fleet to behave in a specific way at runtime.
 
-{% hint style="info" %}
+!!! info
     Unlike the properties defined above, these properties are only accessed via the JVM arguments \(`-D`\).
-{% endhint %}
 
 | Runtime Argument | Purpose |
 | :--- | :--- |
@@ -188,6 +184,5 @@ When starting Fleet for the first time it will create a default user in order fo
 
 **Password**: admin
 
-{% hint style="warning" %}
+!!! warning
     You should change the default password for this user as soon as possible! This can be done via the `Admin` -&gt; `Users` menu options.
-{% endhint %}

docs/general/understanding-puid-and-pgid.md

@@ -1,8 +1,7 @@
 # Understanding PUID and PGID
 
-{% hint style="info" %}
+!!! info
     We are aware that recent versions of the Docker engine have introduced the `--user` flag. Our images are not yet compatible with this, so we recommend continuing usage of PUID and PGID.
-{% endhint %}
 
 ## Why use these?
 

docs/general/updating-our-containers.md

@@ -18,7 +18,8 @@ docker stop <container_name>
 
 Once the container has been stopped, remove it.
 
-> **Important**: Did you remember to persist the `/config` volume when you originally created the container? Bear in mind, you'll lose any configuration inside the container if this volume was not persisted. [Read up on why this is important](volumes.md).
+!!! warning
+    Did you remember to persist the `/config` volume when you originally created the container? Bear in mind, you'll lose any configuration inside the container if this volume was not persisted. [Read up on why this is important](volumes.md).
 
 ```shell
 docker rm <container_name>

docs/general/volumes.md

@@ -20,6 +20,7 @@ docker create --name my_container \
 
 The above example shows how the usage of `-v` has mapped the host machine's `/opt/appdata/my_config` directory over the container's internal `/config` directory.
 
-> **Remember**: When dealing with mapping overlays, it always reads `host:container`
+!!! info
+    When dealing with mapping overlays, it always reads `host:container`
 
 You can do this for as many directories as required by either you or the container itself. Our rule-of-thumb is to _always_ map the `/config` directory as this contains pertinent runtime configuration for the underlying application. For applications that require further data, such as media, our documentation will clearly indicate which internal directories need mapping.