Correct mdx extension for all markdown links

recyclarr · Oct 19, 2024 · e7669c6 · e7669c6
1 parent 1451eb2
commit e7669c6
Show file tree

Hide file tree

Showing 53 changed files with 130 additions and 130 deletions.
diff --git a/docs/_configs-common.mdx b/docs/_configs-common.mdx
@@ -56,8 +56,8 @@ section][include-qp].
 
 Additional custom formats can be added to the configuration file in the same way as normal.
 
-[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
+[cli]: ./cli/config/config-create.mdx#template
+[file-structure]: ./file-structure.mdx#default-yaml
+[behavior]: ./behavior/include.mdx
+[config-qp]: ./yaml/config-reference/quality-profiles.mdx
+[include-qp]: ./behavior/include.mdx#quality-profiles
diff --git a/docs/_include-templates-dir.mdx b/docs/_include-templates-dir.mdx
@@ -29,6 +29,6 @@ directory for those.
 
 :::
 
-[include]: /yaml/config-reference/include.md
-[configdirective]: /yaml/config-reference/include.md#config
-[configsdir]: /file-structure.md#config-directory
+[include]: /yaml/config-reference/include.mdx
+[configdirective]: /yaml/config-reference/include.mdx#config
+[configsdir]: /file-structure.mdx#config-directory
diff --git a/docs/backups.mdx b/docs/backups.mdx
@@ -19,4 +19,4 @@ accepted by Recyclarr.
 
 Files and directories *not* listed above are considered unimportant for backup purposes.
 
-[app-data]: /file-structure.md#appdata-directory
+[app-data]: /file-structure.mdx#appdata-directory
diff --git a/docs/behavior/cache.mdx b/docs/behavior/cache.mdx
@@ -40,5 +40,5 @@ replace CFs that it doesn't own (i.e. that aren't recorded in the cache). Once r
 added for it in the cache, which means you can set `replace_existing_custom_formats` back to
 `false`.
 
-[app-data]: /file-structure.md#appdata-directory
-[replacecf]: /yaml/config-reference/custom-formats.md#replace-existing-custom-formats
+[app-data]: /file-structure.mdx#appdata-directory
+[replacecf]: /yaml/config-reference/custom-formats.mdx#replace-existing-custom-formats
diff --git a/docs/behavior/custom-formats.mdx b/docs/behavior/custom-formats.mdx
@@ -28,4 +28,4 @@ in order to do anything to it (update or delete).
 
 See the [Cache] page.
 
-[Cache]: ./cache.md
+[Cache]: ./cache.mdx
diff --git a/docs/behavior/include.mdx b/docs/behavior/include.mdx
@@ -18,7 +18,7 @@ title: YAML Includes
   A specific method of including a YAML file (e.g. `config: myfile.yml`). The [reference
   docs][includeref] contain a comprehensive list of all include directives.
 
-[includeref]: /yaml/config-reference/include.md
+[includeref]: /yaml/config-reference/include.mdx
 
 ### YAML-Specific Terms {#yaml-terms}
 
@@ -393,6 +393,6 @@ custom_formats:
 
 ### Include File Structure {#file-structure}
 
-import IncludeDirectory from '../_include-templates-dir.md'
+import IncludeDirectory from '../_include-templates-dir.mdx'
 
 <IncludeDirectory />
diff --git a/docs/behavior/migration-system.mdx b/docs/behavior/migration-system.mdx
@@ -22,8 +22,8 @@ Migration Steps can fail. When this happens, instructions are provided to the us
 and/or perform those steps manually. Regardless of the reason, Recyclarr will immediately exit and
 cannot proceed until the advice output during the previous execution is followed.
 
-[sync]: ../cli/sync.md
-[mig]: ../cli/migrate.md
+[sync]: ../cli/sync.mdx
+[mig]: ../cli/migrate.mdx
 
 ## Failure & Recovery
 

diff --git a/docs/behavior/quality-profiles.mdx b/docs/behavior/quality-profiles.mdx
@@ -33,8 +33,8 @@ Because disabled (disallowed) qualities are not technically non-functional, the
 give you some flexibility in how those disabled qualities impact you when they're missing from the
 [`qualities` list][qpqualities] in your configuration YAML.
 
-[qpsort]: /yaml/config-reference/quality-profiles.md#quality-sort
-[qpqualities]: /yaml/config-reference/quality-profiles.md#qualities
+[qpsort]: /yaml/config-reference/quality-profiles.mdx#quality-sort
+[qpqualities]: /yaml/config-reference/quality-profiles.mdx#qualities
 
 ### Top Sort {#top-sort}
 

diff --git a/docs/cli/common.mdx b/docs/cli/common.mdx
@@ -21,7 +21,7 @@ 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
+directory](/file-structure.mdx#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

diff --git a/docs/cli/config/config-create.mdx b/docs/cli/config/config-create.mdx
@@ -12,11 +12,11 @@ recyclarr config create [OPTIONS]
 ## Description
 
 Create a starter configuration YAML file. The location of this file is the [application data
-directory](/file-structure.md#appdata-directory).
+directory](/file-structure.mdx#appdata-directory).
 
 ## Options
 
-Visit [Common Options](../common.md) to read about options usable by all commands.
+Visit [Common Options](../common.mdx) to read about options usable by all commands.
 
 ### `-p|--path` {#path}
 

diff --git a/docs/cli/config/index.mdx b/docs/cli/config/index.mdx
@@ -14,5 +14,5 @@ Commands used to perform configuration-related operations.
 
 ## Commands
 
-- [recyclarr config create](config-create.md)
-- [recyclarr config list](list/index.md)
+- [recyclarr config create](config-create.mdx)
+- [recyclarr config list](list/index.mdx)
diff --git a/docs/cli/config/list/config-list-local.mdx b/docs/cli/config/list/config-list-local.mdx
@@ -13,7 +13,7 @@ recyclarr config list local
 
 Lists all configuration files according to the [default YAML file][1] locations.
 
-[1]: /file-structure.md#default-yaml
+[1]: /file-structure.mdx#default-yaml
 
 ## Command Line Examples
 

diff --git a/docs/cli/config/list/config-list-templates.mdx b/docs/cli/config/list/config-list-templates.mdx
@@ -23,7 +23,7 @@ If specified, this command lists the IDs of all include templates. In contrast t
 templates, which are only usable with the `config create` command, include templates may only be
 included with the [`include` property][include].
 
-[include]: /yaml/config-reference/include.md
+[include]: /yaml/config-reference/include.mdx
 
 ## Command Line Examples
 

diff --git a/docs/cli/config/list/index.mdx b/docs/cli/config/list/index.mdx
@@ -14,5 +14,5 @@ Commands used to perform configuration-related operations.
 
 ## Commands
 
-- [recyclarr config list local](config-list-local.md)
-- [recyclarr config list templates](config-list-templates.md)
+- [recyclarr config list local](config-list-local.mdx)
+- [recyclarr config list templates](config-list-templates.mdx)
diff --git a/docs/cli/delete/delete-custom-formats.mdx b/docs/cli/delete/delete-custom-formats.mdx
@@ -51,7 +51,7 @@ radarr:
     api_key: f7e74ba6c80046e39e076a27af5a8444
 ```
 
-[configref]: /yaml/config-reference/basic.md
+[configref]: /yaml/config-reference/basic.mdx
 
 ### `[cf_names]` {#cf-names}
 
@@ -66,7 +66,7 @@ Any custom formats provided here are ignored if the `--all` option is used.
 
 ## Options
 
-Visit [Common Options](../common.md) to read about options usable by all commands.
+Visit [Common Options](../common.mdx) to read about options usable by all commands.
 
 ### `-a|--all` {#all}
 

diff --git a/docs/cli/delete/index.mdx b/docs/cli/delete/index.mdx
@@ -14,4 +14,4 @@ Allows deletion of various resources in a known, remote service such as Radarr a
 
 ## Commands
 
-- [recyclarr delete custom-formats](delete-custom-formats.md)
+- [recyclarr delete custom-formats](delete-custom-formats.mdx)
diff --git a/docs/cli/index.mdx b/docs/cli/index.mdx
@@ -25,12 +25,12 @@ or angle-brackets (e.g. `<required>`).
 
 ## Commands
 
-Also visit the [Common Options](common.md) page to learn about options and environment variables
+Also visit the [Common Options](common.mdx) page to learn about options and environment variables
 usable across *all* commands.
 
-- [recyclarr](main.md)
-- [recyclarr sync](sync.md)
+- [recyclarr](main.mdx)
+- [recyclarr sync](sync.mdx)
 - [recyclarr list](list)
-- [recyclarr migrate](migrate.md)
+- [recyclarr migrate](migrate.mdx)
 - [recyclarr config](config)
 - [recyclarr delete](delete)
diff --git a/docs/cli/list/index.mdx b/docs/cli/list/index.mdx
@@ -14,6 +14,6 @@ Provides a series of commands used to list information in the guide.
 
 ## Commands
 
-- [recyclarr list custom-formats](list-custom-formats.md)
-- [recyclarr list qualities](list-qualities.md)
-- [recyclarr list naming](list-naming.md)
+- [recyclarr list custom-formats](list-custom-formats.mdx)
+- [recyclarr list qualities](list-qualities.mdx)
+- [recyclarr list naming](list-naming.mdx)
diff --git a/docs/cli/list/list-custom-formats.mdx b/docs/cli/list/list-custom-formats.mdx
@@ -71,14 +71,14 @@ Valid values for this argument are:
 
 ## Options
 
-Visit [Common Options](../common.md) to read about options usable by all commands.
+Visit [Common Options](../common.mdx) to read about options usable by all commands.
 
 ### `--score-sets` {#score-sets}
 
 Instead of listing custom format names, output a list of score sets that can be used with the
 [`score_set` YAML property][scoresetyaml].
 
-[scoresetyaml]: /yaml/config-reference/quality-profiles.md#score-set
+[scoresetyaml]: /yaml/config-reference/quality-profiles.mdx#score-set
 
 ### `--raw` {#raw}
 

diff --git a/docs/cli/list/list-naming.mdx b/docs/cli/list/list-naming.mdx
@@ -25,7 +25,7 @@ media_naming:
   series: default
 ```
 
-[ref]: /yaml/config-reference/media-naming.md
+[ref]: /yaml/config-reference/media-naming.mdx
 
 ## Examples
 
@@ -52,4 +52,4 @@ values for this argument are:
 
 ## Options
 
-Visit [Common Options](../common.md) to read about options usable by all commands.
+Visit [Common Options](../common.mdx) to read about options usable by all commands.
diff --git a/docs/cli/list/list-qualities.mdx b/docs/cli/list/list-qualities.mdx
@@ -38,4 +38,4 @@ values for this argument are:
 
 ## Options
 
-Visit [Common Options](../common.md) to read about options usable by all commands.
+Visit [Common Options](../common.mdx) to read about options usable by all commands.
diff --git a/docs/cli/main.mdx b/docs/cli/main.mdx
@@ -19,7 +19,7 @@ asking for help.
 
 ## Commands
 
-- [recyclarr sync](sync.md)
-- [recyclarr list](list/index.md)
-- [recyclarr migrate](migrate.md)
-- [recyclarr config](config/index.md)
+- [recyclarr sync](sync.mdx)
+- [recyclarr list](list/index.mdx)
+- [recyclarr migrate](migrate.mdx)
+- [recyclarr config](config/index.mdx)
diff --git a/docs/cli/migrate.mdx b/docs/cli/migrate.mdx
@@ -12,8 +12,8 @@ recyclarr migrate [OPTIONS]
 ## Description
 
 Performs upgrade steps that may be needed between major versions of Recyclarr. Visit the [Migration
-System](/behavior/migration-system.md) page to read more about it.
+System](/behavior/migration-system.mdx) page to read more about it.
 
 ## Options
 
-Visit [Common Options](common.md) to read about options usable by all commands.
+Visit [Common Options](common.mdx) to read about options usable by all commands.
diff --git a/docs/cli/sync.mdx b/docs/cli/sync.mdx
@@ -42,7 +42,7 @@ recyclarr sync sonarr
 
 One or more paths to YAML configuration files. If this argument is not specified, default
 configuration files will be used according to rules documented on the [File
-Structure](../file-structure.md) page.
+Structure](../file-structure.mdx) page.
 
 :::tip
 

diff --git a/docs/file-structure.mdx b/docs/file-structure.mdx
@@ -58,6 +58,6 @@ instead.
 
 ## Include Templates Directory {#include-directory}
 
-import IncludeDirectory from './_include-templates-dir.md'
+import IncludeDirectory from './_include-templates-dir.mdx'
 
 <IncludeDirectory />
diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx
@@ -6,7 +6,7 @@ title: Getting Started
 
 :::warning
 
-Please make sure you've reviewed the various [installation methods](installation/index.md) before
+Please make sure you've reviewed the various [installation methods](installation/index.mdx) before
 getting started here.
 
 :::
@@ -21,7 +21,7 @@ want to get started with a minimal configuration file.
 <details>
 <summary>Docker</summary>
 
-[Installation Instructions](installation/docker.md)
+[Installation Instructions](installation/docker.mdx)
 
 The steps below assume you are using Docker Compose with a service named `recyclarr`. You are
 responsible for translating these steps appropriately for other solutions like Docker Swarm,
@@ -34,8 +34,8 @@ Kubernetes, raw Docker, etc.
    and [examples] pages to assist you in understanding an editing other parts of the file as you see
    fit.
 
-If you're using [Cron Mode](installation/docker.md#cron-mode), your work ends here. If you want to
-verify the behavior by [running manually](installation/docker.md#manual-mode), then you can execute
+If you're using [Cron Mode](installation/docker.mdx#cron-mode), your work ends here. If you want to
+verify the behavior by [running manually](installation/docker.mdx#manual-mode), then you can execute
 `docker compose run --rm recyclarr sync` to update all instances using the configuration provided in
 the previous step.
 
@@ -44,7 +44,7 @@ the previous step.
 <details>
 <summary>Manual Installation</summary>
 
-[Installation Instructions](installation/manual-install.md)
+[Installation Instructions](installation/manual-install.mdx)
 
 1. Run `recyclarr config create` to create a starter `recyclarr.yml` file in the [application data
    directory][appdata].
@@ -60,16 +60,16 @@ the previous step.
 Each command supports printing help on the command line. Simply run `recyclarr --help` for the main
 help output and a list of commands. You can then see the help for each command by running `recyclarr
 [command] --help`, where `[command]` is one of those commands (e.g. `sync`). You can also visit the
-[CLI Reference](cli/index.md) page for detailed documentation as well.
+[CLI Reference](cli/index.mdx) page for detailed documentation as well.
 
 :::tip
 
 If you want to organize your configuration into multiple YAML files, learn about [how YAML files are
-loaded](file-structure.md#default-yaml) and look at [examples of how to split your
-files](yaml/configuration-examples.md)
+loaded](file-structure.mdx#default-yaml) and look at [examples of how to split your
+files](yaml/configuration-examples.mdx)
 
 :::
 
-[appdata]: /file-structure.md#appdata-directory
-[reference]: /yaml/config-reference/index.md
-[examples]: /yaml/configuration-examples.md
+[appdata]: /file-structure.mdx#appdata-directory
+[reference]: /yaml/config-reference/index.mdx
+[examples]: /yaml/configuration-examples.mdx
diff --git a/docs/guide-configs.mdx b/docs/guide-configs.mdx
@@ -5,7 +5,7 @@ sidebar_class_name: hidden # It's in the nav title bar
 hide_table_of_contents: true
 ---
 
-import Session from './_configs-common.md';
+import Session from './_configs-common.mdx';
 
 Recyclarr offers pre-built configuration files that can be used as a straightforward method of
 deploying one of more of the TRaSH Guides profiles:

diff --git a/docs/installation/docker.mdx b/docs/installation/docker.mdx
@@ -300,7 +300,7 @@ This runs it without any command or options, which will result in this mode bein
 
 ## Troubleshooting
 
-See the [Troubleshooting](/troubleshooting/errors-warnings.md#docker) page.
+See the [Troubleshooting](/troubleshooting/errors-warnings.mdx#docker) page.
 
 ## Advanced Configuration
 

diff --git a/docs/installation/index.mdx b/docs/installation/index.mdx
@@ -11,18 +11,18 @@ Unraid is a popular platform for many Recyclarr users. Because of this, there ar
 methods specific to this platform. If you do not use Unraid, please refer to the Docker or Manual
 installation methods.
 
-[Unraid Instructions](unraid.md)
+[Unraid Instructions](unraid.mdx)
 
 ## Docker Compose
 
 For most platforms, it is recommended to use the Docker Image to install Recyclarr. Using this
 method, you get to enjoy an easier installation process without having to worry about things like
 file locations, dependencies, etc.
 
-[Docker Compose Instructions](docker.md)
+[Docker Compose Instructions](docker.mdx)
 
 ## Manual Installation
 
 Install and run Recyclarr directly on your host machine. This does not utilize Docker at all.
 
-[Manual Instructions](manual-install.md)
+[Manual Instructions](manual-install.mdx)
diff --git a/docs/installation/manual-install.mdx b/docs/installation/manual-install.mdx
@@ -8,7 +8,7 @@ sidebar_position: 3
 
 The following dependencies are required on **all** platforms.
 
-- Git v2.0 or greater ([Instructions for Windows Users](/installation/tips/git-install.md))
+- Git v2.0 or greater ([Instructions for Windows Users](/installation/tips/git-install.mdx))
 
 ## Download
 

diff --git a/docs/installation/unraid.mdx b/docs/installation/unraid.mdx
@@ -17,8 +17,8 @@ Unraid. **All credit for these solutions goes to their respective authors and ma
 
 :::
 
-[Docker]: ./docker.md
-[Manual]: ./manual-install.md
+[Docker]: ./docker.mdx
+[Manual]: ./manual-install.mdx
 
 ## Community App (Template)
 

diff --git a/docs/schema-validation.mdx b/docs/schema-validation.mdx
@@ -70,6 +70,6 @@ The `yaml.customTags` setting is documented [here][custom-tags].
 [vs-code-setup]: https://code.visualstudio.com/docs/setup/setup-overview
 [vs-code-ext-inst]: https://code.visualstudio.com/learn/get-started/extensions
 [yaml]: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
-[Configuration YAML]: /yaml/config-reference/index.md#schema
-[Settings YAML]: /yaml/settings-reference/index.md#schema
+[Configuration YAML]: /yaml/config-reference/index.mdx#schema
+[Settings YAML]: /yaml/settings-reference/index.mdx#schema
 [custom-tags]: https://github.com/redhat-developer/vscode-yaml#extension-settings