diff --git a/UpgradeDocusaurus.ps1 b/UpgradeDocusaurus.ps1
index 8cc163f..0559bbc 100644
--- a/UpgradeDocusaurus.ps1
+++ b/UpgradeDocusaurus.ps1
@@ -3,4 +3,5 @@ yarn upgrade --latest `
"@docusaurus/core" `
"@docusaurus/preset-classic" `
"@docusaurus/module-type-aliases" `
+ "docusaurus-mdx-checker" `
"@iconify/react"
diff --git a/docs/_configs-common.md b/docs/_configs-common.md
index 1223487..b2796b5 100644
--- a/docs/_configs-common.md
+++ b/docs/_configs-common.md
@@ -1,16 +1,16 @@
These pre-built configuration files are composed of two primary elements:
-- Includes
+- **Includes**
[Include templates][include-templates] are utilized to synchronize all mandatory elements of any
given guide profile. These are split into `quality_definition`, `quality_profile` and
- `custom_formats` elements. If any of these are not desired, they can be commented out.
- The content of these include templates can be found in the
- [Recyclarr config-templates GitHub repository][config-templates-repo].
+ `custom_formats` elements. If any of these are not desired, they can be commented out. The content
+ of these include templates can be found in the [Recyclarr config-templates GitHub
+ repository][config-templates-repo].
[include-templates]: https://recyclarr.dev/wiki/yaml/config-reference/include/#template
[config-templates-repo]: https://github.com/recyclarr/config-templates
-- Custom Formats
+- **Custom Formats**
Custom formats that are added to the pre-built configuration file directly - i.e., not by way of
an include - allow the user to choose from one or more profile variations. These choices mirror
those described on the TRaSH Guides profile pages. Comments are provided in the pre-built
@@ -21,45 +21,44 @@ These pre-built configuration files are composed of two primary elements:
The pre-built configuration files can be deployed in two ways:
-- Via the CLI using [`recyclarr config create -t`][recyclarr-config-create-t].
-- Manually, by copying the contents of the relevant pre-built configuration file into a
- [supported file location][file-structure]. The files can be found in the index below.
-
- [recyclarr-config-create-t]: https://recyclarr.dev/wiki/cli/config/create/#-t--template
- [file-structure]: https://recyclarr.dev/wiki/file-structure/#default-yaml
+- Via the CLI using [`recyclarr config create -t`][cli].
+- Manually, by copying the contents of the relevant pre-built configuration file into a [supported
+ file location][file-structure]. The files can be found in the index below.
## Customization
:::warning
The pre-built configuration files are designed as a simple mechanism to deploy one or more of the
-TRaSH Guides profiles, in exactly the same configuration as they appear on the guides pages.
-Minimal customization is possible, however more extensive customization usually necessitates
-building your own custom configuration file.
+TRaSH Guides profiles, in exactly the same configuration as they appear on the guides pages. Minimal
+customization is possible, however more extensive customization usually necessitates building your
+own custom configuration file.
:::
:::warning
At this time, include templates can only be used with quality profiles that have the **same name**
-as shown in the equivalent guide profile page. The profile name is hard-coded into the
-include template.
+as shown in the equivalent guide profile page. The profile name is hard-coded into the include
+template.
:::
-As the pre-built configuration files feature include templates, these will need to be overridden
-by custom configuration added to the configuration file.
-[Guidance is available on this behavior][behavior-include].
+As the pre-built configuration files feature include templates, these will need to be overridden by
+custom configuration added to the configuration file. [Guidance is available on this
+behavior][behavior].
-[behavior-include]: https://recyclarr.dev/wiki/behavior/include/.
-A common request is to add additional qualities to a [quality profile][quality-profile]. This is
-as simple as writing your own complete quality profile configuration and adding it to your
-configuration file. From there, the quality profile include template can either be commented out,
-or if left enabled then Recyclarr will process the customized configuration as described in the
-[include behavior section][behavior-include-quality-profiles].
+A common request is to add additional qualities to a [quality profile][config-qp]. This is as simple
+as writing your own complete quality profile configuration and adding it to your configuration file.
+From there, the quality profile include template can either be commented out, or if left enabled
+then Recyclarr will process the customized configuration as described in the [include behavior
+section][include-qp].
Additional custom formats can be added to the configuration file in the same way as normal.
-[quality-profile]: https://recyclarr.dev/wiki/yaml/config-reference/quality-profiles/
-[behavior-include-quality-profiles]: https://recyclarr.dev/wiki/behavior/include/#quality-profiles
+[cli]: ./cli/config/config-create.md#template
+[file-structure]: ./file-structure.md#default-yaml
+[behavior]: ./behavior/include.md
+[config-qp]: ./yaml/config-reference/quality-profiles.md
+[include-qp]: ./behavior/include.md#quality-profiles
diff --git a/docs/cli/common.md b/docs/cli/common.md
index f77c6c4..90f86ec 100644
--- a/docs/cli/common.md
+++ b/docs/cli/common.md
@@ -19,8 +19,8 @@ generally will be too noisy for normal program usage.
### `--app-data` {#app-data}
Overrides the normal, default location of the [application data
-directory](/file-structure.md#appdata-directory). Note that this option is mainly intended for
-usage in the official Docker image. It is not intended for normal use outside of that.
+directory](/file-structure.md#appdata-directory). Note that this option is mainly intended for usage
+in the official Docker image. It is not intended for normal use outside of that.
If you'd like this behavior globally for all commands without having to specify this option, define
an environment variable named `RECYCLARR_APP_DATA` with the same path. Note that if you have both
diff --git a/package.json b/package.json
index ed8944b..263c9a9 100644
--- a/package.json
+++ b/package.json
@@ -21,6 +21,7 @@
"@mdx-js/react": "^3",
"@types/react": "^18",
"clsx": "^2.0.0",
+ "docusaurus-mdx-checker": "^3.0.0",
"docusaurus-theme-github-codeblock": "^2.0.2",
"prism-react-renderer": "^1.3.5",
"react": "^18.2.0",
diff --git a/yarn.lock b/yarn.lock
index 465f27c..1662aff 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -2440,6 +2440,11 @@
resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.11.tgz#d421b6c527a3037f7c84433fd2c4229e016863d3"
integrity sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==
+"@types/katex@^0.16.0":
+ version "0.16.7"
+ resolved "https://registry.yarnpkg.com/@types/katex/-/katex-0.16.7.tgz#03ab680ab4fa4fbc6cb46ecf987ecad5d8019868"
+ integrity sha512-HMwFiRujE5PjrgwHQ25+bsLJgowjGjm5Z8FVSf0N6PwgJrwxH0QxzHYDcKsTfV3wva0vzrpqMTJS2jXPr5BMEQ==
+
"@types/mdast@^4.0.0", "@types/mdast@^4.0.2":
version "4.0.3"
resolved "https://registry.yarnpkg.com/@types/mdast/-/mdast-4.0.3.tgz#1e011ff013566e919a4232d1701ad30d70cab333"
@@ -2792,7 +2797,7 @@ acorn-walk@^8.0.0:
resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.2.0.tgz#741210f2e2426454508853a2f44d0ab83b7f69c1"
integrity sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==
-acorn@^8.0.0, acorn@^8.8.2:
+acorn@^8.0.0, acorn@^8.10.0, acorn@^8.8.2:
version "8.11.3"
resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.11.3.tgz#71e0b14e13a4ec160724b38fb7b0f233b1b81d7a"
integrity sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==
@@ -3250,7 +3255,7 @@ chalk@^4.0.0, chalk@^4.1.0, chalk@^4.1.2:
ansi-styles "^4.1.0"
supports-color "^7.1.0"
-chalk@^5.0.1, chalk@^5.2.0:
+chalk@^5.0.1, chalk@^5.2.0, chalk@^5.3.0:
version "5.3.0"
resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.3.0.tgz#67c20a7ebef70e7f3970a01f90fa210cb6860385"
integrity sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==
@@ -3431,6 +3436,11 @@ commander@^10.0.0:
resolved "https://registry.yarnpkg.com/commander/-/commander-10.0.1.tgz#881ee46b4f77d1c1dccc5823433aa39b022cbe06"
integrity sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==
+commander@^11.0.0:
+ version "11.1.0"
+ resolved "https://registry.yarnpkg.com/commander/-/commander-11.1.0.tgz#62fdce76006a68e5c1ab3314dc92e800eb83d906"
+ integrity sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==
+
commander@^2.20.0:
version "2.20.3"
resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"
@@ -3971,6 +3981,24 @@ dns-packet@^5.2.2:
dependencies:
"@leichtgewicht/ip-codec" "^2.0.1"
+docusaurus-mdx-checker@^3.0.0:
+ version "3.0.0"
+ resolved "https://registry.yarnpkg.com/docusaurus-mdx-checker/-/docusaurus-mdx-checker-3.0.0.tgz#7c9389a3959ac5d641accf4f7ca7f0e19a3c2b61"
+ integrity sha512-xNZcOTPGfhYXoAA5htdmNH9iSUlwu3m9BC5prLA158ZsgB35rsQ9DeWAYRvq7qy0wJ8cwMaqYfh/1HxJpP2r/Q==
+ dependencies:
+ "@mdx-js/mdx" "^3.0.0"
+ "@slorber/remark-comment" "^1.0.0"
+ acorn "^8.10.0"
+ chalk "^5.3.0"
+ commander "^11.0.0"
+ globby "^13.2.2"
+ lodash "^4.17.21"
+ periscopic "^3.1.0"
+ remark-directive "^3.0.0"
+ remark-frontmatter "^5.0.0"
+ remark-gfm "^4.0.0"
+ remark-math "^6.0.0"
+
docusaurus-theme-github-codeblock@^2.0.2:
version "2.0.2"
resolved "https://registry.yarnpkg.com/docusaurus-theme-github-codeblock/-/docusaurus-theme-github-codeblock-2.0.2.tgz#88b7044b81f9091330e8e4a07a1bdc9114a9fb93"
@@ -4367,6 +4395,17 @@ fast-glob@^3.2.11, fast-glob@^3.2.9:
merge2 "^1.3.0"
micromatch "^4.0.4"
+fast-glob@^3.3.0:
+ version "3.3.2"
+ resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.2.tgz#a904501e57cfdd2ffcded45e99a54fef55e46129"
+ integrity sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==
+ dependencies:
+ "@nodelib/fs.stat" "^2.0.2"
+ "@nodelib/fs.walk" "^1.2.3"
+ glob-parent "^5.1.2"
+ merge2 "^1.3.0"
+ micromatch "^4.0.4"
+
fast-json-stable-stringify@^2.0.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633"
@@ -4675,6 +4714,17 @@ globby@^13.1.1:
merge2 "^1.4.1"
slash "^4.0.0"
+globby@^13.2.2:
+ version "13.2.2"
+ resolved "https://registry.yarnpkg.com/globby/-/globby-13.2.2.tgz#63b90b1bf68619c2135475cbd4e71e66aa090592"
+ integrity sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==
+ dependencies:
+ dir-glob "^3.0.1"
+ fast-glob "^3.3.0"
+ ignore "^5.2.4"
+ merge2 "^1.4.1"
+ slash "^4.0.0"
+
got@^12.1.0:
version "12.6.1"
resolved "https://registry.yarnpkg.com/got/-/got-12.6.1.tgz#8869560d1383353204b5a9435f782df9c091f549"
@@ -5064,6 +5114,11 @@ ignore@^5.2.0:
resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.2.0.tgz#6d3bac8fa7fe0d45d9f9be7bac2fc279577e345a"
integrity sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==
+ignore@^5.2.4:
+ version "5.3.1"
+ resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.3.1.tgz#5073e554cd42c5b33b394375f538b8593e34d4ef"
+ integrity sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==
+
image-size@^1.0.2:
version "1.1.1"
resolved "https://registry.yarnpkg.com/image-size/-/image-size-1.1.1.tgz#ddd67d4dc340e52ac29ce5f546a09f4e29e840ac"
@@ -5475,6 +5530,13 @@ jsonfile@^6.0.1:
optionalDependencies:
graceful-fs "^4.1.6"
+katex@^0.16.0:
+ version "0.16.10"
+ resolved "https://registry.yarnpkg.com/katex/-/katex-0.16.10.tgz#6f81b71ac37ff4ec7556861160f53bc5f058b185"
+ integrity sha512-ZiqaC04tp2O5utMsl2TEZTXxa6WSC4yo0fv5ML++D3QZv/vx2Mct0mTlRx3O+uUkjfuAgOkzsCmq5MiUEsDDdA==
+ dependencies:
+ commander "^8.3.0"
+
keyv@^4.5.3:
version "4.5.4"
resolved "https://registry.yarnpkg.com/keyv/-/keyv-4.5.4.tgz#a879a99e29452f942439f2a405e3af8b31d4de93"
@@ -5750,6 +5812,19 @@ mdast-util-gfm@^3.0.0:
mdast-util-gfm-task-list-item "^2.0.0"
mdast-util-to-markdown "^2.0.0"
+mdast-util-math@^3.0.0:
+ version "3.0.0"
+ resolved "https://registry.yarnpkg.com/mdast-util-math/-/mdast-util-math-3.0.0.tgz#8d79dd3baf8ab8ac781f62b8853768190b9a00b0"
+ integrity sha512-Tl9GBNeG/AhJnQM221bJR2HPvLOSnLE/T9cJI9tlc6zwQk2nPk/4f0cHkOdEixQPC/j8UtKDdITswvLAy1OZ1w==
+ dependencies:
+ "@types/hast" "^3.0.0"
+ "@types/mdast" "^4.0.0"
+ devlop "^1.0.0"
+ longest-streak "^3.0.0"
+ mdast-util-from-markdown "^2.0.0"
+ mdast-util-to-markdown "^2.1.0"
+ unist-util-remove-position "^5.0.0"
+
mdast-util-mdx-expression@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.0.tgz#4968b73724d320a379110d853e943a501bfd9d87"
@@ -5826,7 +5901,7 @@ mdast-util-to-hast@^13.0.0:
unist-util-position "^5.0.0"
unist-util-visit "^5.0.0"
-mdast-util-to-markdown@^2.0.0:
+mdast-util-to-markdown@^2.0.0, mdast-util-to-markdown@^2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.0.tgz#9813f1d6e0cdaac7c244ec8c6dabfdb2102ea2b4"
integrity sha512-SR2VnIEdVNCJbP6y7kVTJgPLifdr8WEU440fQec7qHoHOUz/oJ2jmNRqdDQ3rbiStOXb2mCDGTuwsK5OPUgYlQ==
@@ -6008,6 +6083,19 @@ micromark-extension-gfm@^3.0.0:
micromark-util-combine-extensions "^2.0.0"
micromark-util-types "^2.0.0"
+micromark-extension-math@^3.0.0:
+ version "3.0.0"
+ resolved "https://registry.yarnpkg.com/micromark-extension-math/-/micromark-extension-math-3.0.0.tgz#c7a47d6ce990812243ad3946a30bb60e4c2a8c76"
+ integrity sha512-iJ2Q28vBoEovLN5o3GO12CpqorQRYDPT+p4zW50tGwTfJB+iv/VnB6Ini+gqa24K97DwptMBBIvVX6Bjk49oyQ==
+ dependencies:
+ "@types/katex" "^0.16.0"
+ devlop "^1.0.0"
+ katex "^0.16.0"
+ micromark-factory-space "^2.0.0"
+ micromark-util-character "^2.0.0"
+ micromark-util-symbol "^2.0.0"
+ micromark-util-types "^2.0.0"
+
micromark-extension-mdx-expression@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/micromark-extension-mdx-expression/-/micromark-extension-mdx-expression-3.0.0.tgz#1407b9ce69916cf5e03a196ad9586889df25302a"
@@ -6774,7 +6862,7 @@ path-type@^4.0.0:
resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b"
integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==
-periscopic@^3.0.0:
+periscopic@^3.0.0, periscopic@^3.1.0:
version "3.1.0"
resolved "https://registry.yarnpkg.com/periscopic/-/periscopic-3.1.0.tgz#7e9037bf51c5855bd33b48928828db4afa79d97a"
integrity sha512-vKiQ8RRtkl9P+r/+oefh25C3fhybptkHKCZSPlcXiJux2tJF55GnEj3BVn4A5gKfq9NWWXXrxkHBwVPUfH0opw==
@@ -7616,6 +7704,16 @@ remark-gfm@^4.0.0:
remark-stringify "^11.0.0"
unified "^11.0.0"
+remark-math@^6.0.0:
+ version "6.0.0"
+ resolved "https://registry.yarnpkg.com/remark-math/-/remark-math-6.0.0.tgz#0acdf74675f1c195fea6efffa78582f7ed7fc0d7"
+ integrity sha512-MMqgnP74Igy+S3WwnhQ7kqGlEerTETXMvJhrUzDikVZ2/uogJCb+WHUg97hK9/jcfc0dkD73s3LN8zU49cTEtA==
+ dependencies:
+ "@types/mdast" "^4.0.0"
+ mdast-util-math "^3.0.0"
+ micromark-extension-math "^3.0.0"
+ unified "^11.0.0"
+
remark-mdx@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/remark-mdx/-/remark-mdx-3.0.0.tgz#146905a3925b078970e05fc89b0e16b9cc3bfddd"