From a4d0f387d17ae3688550bee637a8a03dda984f05 Mon Sep 17 00:00:00 2001 From: Eric Nemchik Date: Thu, 22 Oct 2020 10:25:19 -0500 Subject: [PATCH] Setup mkdocs --- .github/workflows/lint.yml | 29 +++++++++++++++ .github/workflows/mkdocs.yml | 27 ++++++++++++++ {Bazarr => docs/Bazarr}/2to3_language_code.sh | 0 ...r-compose-when-you-need-help-on-Discord.md | 0 ...w-to-setup-Torguard-for-port-forwarding.md | 0 .../Misc}/images/image-20200204202420342.png | Bin .../Misc}/images/image-20200204205929031.png | Bin .../Misc}/images/image-20200204210425170.png | Bin .../Misc}/images/image-20200204211350592.png | Bin .../Misc}/images/image-20200204211942538.png | Bin .../Misc}/images/image-20200204212650314.png | Bin .../Misc}/images/image-20200204212748924.png | Bin .../Misc}/images/image-20200204215938930.png | Bin .../images/torguard-FreeTrial-728x90.gif | Bin {Misc => docs/Misc}/x265-4k.md | 0 .../NZBGet}/How-to-setup-NZBGet.md | 0 {NZBGet => docs/NZBGet}/README.md | 0 .../NZBGet}/images/1571588271831.png | Bin .../NZBGet}/images/1571593246863.png | Bin .../NZBGet}/images/1571593790053.png | Bin .../NZBGet}/images/1571593877357.png | Bin .../images/image-20191201110525320.png | Bin .../images/image-20200209125552547.png | Bin .../images/image-20200209130241801.png | Bin .../images/image-20200209130753069.png | Bin .../images/image-20200209131003689.png | Bin .../NZBGet}/scripts/Clean/Clean.py | 0 .../NZBGet}/scripts/Clean/README.md | 0 .../scripts/HashRenamer/HashRenamer.py | 0 .../NZBGet}/scripts/HashRenamer/README.md | 0 {NZBGet => docs/NZBGet}/scripts/README.md | 0 .../NZBGet}/scripts/WtFnZb-Renamer/README.md | 0 .../scripts/WtFnZb-Renamer/WtFnZb-Renamer.py | 0 .../Android-SHIELD Android TV.xml | 0 .../Plex}/Profiles/Chromecast/Chromecast.xml | 0 {Plex => docs/Plex}/Profiles/README.md | 0 {Plex => docs/Plex}/README.md | 0 ...Collection-of-Custom-Formats-for-Radarr.md | 0 .../Radarr}/How-to-get-Quality-Releases.md | 0 ...-sure-Radarr-doesnt-snatch-Full-BluRays.md | 0 ...mote-Path-Mappings-explained-for-Radarr.md | 0 .../animated-exclamation-mark-image-0003.gif | Bin ...lamation-mark-image-0006-1581778299523.gif | Bin .../animated-exclamation-mark-image-0006.gif | Bin .../images/image-20191027165122728.png | Bin .../images/image-20191027165328556.png | Bin .../images/image-20191027165508102.png | Bin .../images/image-20191027170313598.png | Bin .../images/image-20200209165701743.png | Bin .../images/image-20200307121133057.png | Bin .../images/image-20200307121221123.png | Bin .../images/image-20200307121316716.png | Bin .../images/image-20200307121406542.png | Bin .../images/image-20200307121755593.png | Bin .../images/image-20200307121910786.png | Bin .../images/image-20200307123131923.png | Bin .../images/image-20200307123344848.png | Bin .../images/image-20200307123503158.png | Bin .../images/image-20200517185154185.png | Bin .../images/image-20200517185901176.png | Bin .../images/image-20200517190028898.png | Bin ...llection-of-Custom-Formats-for-RadarrV3.md | 0 ...Custom-Formats-and-truly-make-use-of-it.md | 0 .../Radarr-Quality-Settings-File-Size.md | 0 ...darr-recommended-naming-scheme-examples.md | 0 .../images/image-20200926105858168.png | Bin .../images/image-20200926110018973.png | Bin .../images/image-20200926110122043.png | Bin .../images/image-20200926110751639.png | Bin .../images/image-20200926111254181.png | Bin .../images/image-20200926113435255.png | Bin .../images/image-20200926114854509.png | Bin .../images/image-20200926114938367.png | Bin .../images/image-20200926115916590.png | Bin .../images/image-20200926120736230.png | Bin .../images/image-20201007190601478.png | Bin ...w-To-Seperate-Different-WEB-DL-Releases.md | 0 ...estrictions-For-Better-Quality-Releases.md | 0 {SonarrV3 => docs/SonarrV3}/README.md | 0 ...mote-Path-Mappings-explained-for-Sonarr.md | 0 .../Sonarr-Quality-Settings-File-Size.md | 0 .../SonarrV3}/Sonarr-Release-Profile-RegEx.md | 0 ...narr-recommended-naming-scheme-examples.md | 0 .../SonarrV3}/images/1549734647618.png | Bin .../SonarrV3}/images/1549734726771.png | Bin .../SonarrV3}/images/1549734875590.png | Bin .../SonarrV3}/images/1549734928236.png | Bin .../SonarrV3}/images/1549734986119.png | Bin .../SonarrV3}/images/1549735082937.png | Bin .../SonarrV3}/images/1549735142149.png | Bin .../SonarrV3}/images/1571573554399.png | Bin .../SonarrV3}/images/1571575011671.png | Bin ...lamation-mark-image-0006-1581778210859.gif | Bin .../animated-exclamation-mark-image-0006.gif | Bin .../images/image-20200930190924569.png | Bin .../images/image-20200930194224862.png | Bin .../images/image-20201004135035478.png | Bin .../images/image-20201010205202708.png | Bin .../images/image-20201011124833659.png | Bin mkdocs.yml | 33 ++++++++++++++++++ 100 files changed, 89 insertions(+) create mode 100644 .github/workflows/lint.yml create mode 100644 .github/workflows/mkdocs.yml rename {Bazarr => docs/Bazarr}/2to3_language_code.sh (100%) rename {Misc => docs/Misc}/How-to-provide-a-docker-compose-when-you-need-help-on-Discord.md (100%) rename {Misc => docs/Misc}/How-to-setup-Torguard-for-port-forwarding.md (100%) rename {Misc => docs/Misc}/images/image-20200204202420342.png (100%) rename {Misc => docs/Misc}/images/image-20200204205929031.png (100%) rename {Misc => docs/Misc}/images/image-20200204210425170.png (100%) rename {Misc => docs/Misc}/images/image-20200204211350592.png (100%) rename {Misc => docs/Misc}/images/image-20200204211942538.png (100%) rename {Misc => docs/Misc}/images/image-20200204212650314.png (100%) rename {Misc => docs/Misc}/images/image-20200204212748924.png (100%) rename {Misc => docs/Misc}/images/image-20200204215938930.png (100%) rename {Misc => docs/Misc}/images/torguard-FreeTrial-728x90.gif (100%) rename {Misc => docs/Misc}/x265-4k.md (100%) rename {NZBGet => docs/NZBGet}/How-to-setup-NZBGet.md (100%) rename {NZBGet => docs/NZBGet}/README.md (100%) rename {NZBGet => docs/NZBGet}/images/1571588271831.png (100%) rename {NZBGet => docs/NZBGet}/images/1571593246863.png (100%) rename {NZBGet => docs/NZBGet}/images/1571593790053.png (100%) rename {NZBGet => docs/NZBGet}/images/1571593877357.png (100%) rename {NZBGet => docs/NZBGet}/images/image-20191201110525320.png (100%) rename {NZBGet => docs/NZBGet}/images/image-20200209125552547.png (100%) rename {NZBGet => docs/NZBGet}/images/image-20200209130241801.png (100%) rename {NZBGet => docs/NZBGet}/images/image-20200209130753069.png (100%) rename {NZBGet => docs/NZBGet}/images/image-20200209131003689.png (100%) rename {NZBGet => docs/NZBGet}/scripts/Clean/Clean.py (100%) rename {NZBGet => docs/NZBGet}/scripts/Clean/README.md (100%) rename {NZBGet => docs/NZBGet}/scripts/HashRenamer/HashRenamer.py (100%) rename {NZBGet => docs/NZBGet}/scripts/HashRenamer/README.md (100%) rename {NZBGet => docs/NZBGet}/scripts/README.md (100%) rename {NZBGet => docs/NZBGet}/scripts/WtFnZb-Renamer/README.md (100%) rename {NZBGet => docs/NZBGet}/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py (100%) rename {Plex => docs/Plex}/Profiles/Android-SHIELD/Android-SHIELD Android TV.xml (100%) rename {Plex => docs/Plex}/Profiles/Chromecast/Chromecast.xml (100%) rename {Plex => docs/Plex}/Profiles/README.md (100%) rename {Plex => docs/Plex}/README.md (100%) rename {Radarr => docs/Radarr}/Collection-of-Custom-Formats-for-Radarr.md (100%) rename {Radarr => docs/Radarr}/How-to-get-Quality-Releases.md (100%) rename {Radarr => docs/Radarr}/How-to-make-sure-Radarr-doesnt-snatch-Full-BluRays.md (100%) rename {Radarr => docs/Radarr}/Remote-Path-Mappings-explained-for-Radarr.md (100%) rename {Radarr => docs/Radarr}/images/animated-exclamation-mark-image-0003.gif (100%) rename {Radarr => docs/Radarr}/images/animated-exclamation-mark-image-0006-1581778299523.gif (100%) rename {Radarr => docs/Radarr}/images/animated-exclamation-mark-image-0006.gif (100%) rename {Radarr => docs/Radarr}/images/image-20191027165122728.png (100%) rename {Radarr => docs/Radarr}/images/image-20191027165328556.png (100%) rename {Radarr => docs/Radarr}/images/image-20191027165508102.png (100%) rename {Radarr => docs/Radarr}/images/image-20191027170313598.png (100%) rename {Radarr => docs/Radarr}/images/image-20200209165701743.png (100%) rename {Radarr => docs/Radarr}/images/image-20200307121133057.png (100%) rename {Radarr => docs/Radarr}/images/image-20200307121221123.png (100%) rename {Radarr => docs/Radarr}/images/image-20200307121316716.png (100%) rename {Radarr => docs/Radarr}/images/image-20200307121406542.png (100%) rename {Radarr => docs/Radarr}/images/image-20200307121755593.png (100%) rename {Radarr => docs/Radarr}/images/image-20200307121910786.png (100%) rename {Radarr => docs/Radarr}/images/image-20200307123131923.png (100%) rename {Radarr => docs/Radarr}/images/image-20200307123344848.png (100%) rename {Radarr => docs/Radarr}/images/image-20200307123503158.png (100%) rename {Radarr => docs/Radarr}/images/image-20200517185154185.png (100%) rename {Radarr => docs/Radarr}/images/image-20200517185901176.png (100%) rename {Radarr => docs/Radarr}/images/image-20200517190028898.png (100%) rename {RadarrV3 => docs/RadarrV3}/Collection-of-Custom-Formats-for-RadarrV3.md (100%) rename {RadarrV3 => docs/RadarrV3}/How-to-importexport-Custom-Formats-and-truly-make-use-of-it.md (100%) rename {RadarrV3 => docs/RadarrV3}/Radarr-Quality-Settings-File-Size.md (100%) rename {RadarrV3 => docs/RadarrV3}/Radarr-recommended-naming-scheme-examples.md (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926105858168.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926110018973.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926110122043.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926110751639.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926111254181.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926113435255.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926114854509.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926114938367.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926115916590.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20200926120736230.png (100%) rename {RadarrV3 => docs/RadarrV3}/images/image-20201007190601478.png (100%) rename {SonarrV2 => docs/SonarrV2}/How-To-Seperate-Different-WEB-DL-Releases.md (100%) rename {SonarrV2 => docs/SonarrV2}/Restrictions-For-Better-Quality-Releases.md (100%) rename {SonarrV3 => docs/SonarrV3}/README.md (100%) rename {SonarrV3 => docs/SonarrV3}/Remote-Path-Mappings-explained-for-Sonarr.md (100%) rename {SonarrV3 => docs/SonarrV3}/Sonarr-Quality-Settings-File-Size.md (100%) rename {SonarrV3 => docs/SonarrV3}/Sonarr-Release-Profile-RegEx.md (100%) rename {SonarrV3 => docs/SonarrV3}/Sonarr-recommended-naming-scheme-examples.md (100%) rename {SonarrV3 => docs/SonarrV3}/images/1549734647618.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/1549734726771.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/1549734875590.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/1549734928236.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/1549734986119.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/1549735082937.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/1549735142149.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/1571573554399.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/1571575011671.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/animated-exclamation-mark-image-0006-1581778210859.gif (100%) rename {SonarrV3 => docs/SonarrV3}/images/animated-exclamation-mark-image-0006.gif (100%) rename {SonarrV3 => docs/SonarrV3}/images/image-20200930190924569.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/image-20200930194224862.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/image-20201004135035478.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/image-20201010205202708.png (100%) rename {SonarrV3 => docs/SonarrV3}/images/image-20201011124833659.png (100%) create mode 100644 mkdocs.yml diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 000000000..2cda542e6 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,29 @@ +name: Lint + +on: [push, pull_request] + +jobs: + + editorconfig-checker: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2.3.3 + - name: editorconfig-checker + run: | + docker run --rm -v ${GITHUB_WORKSPACE}:/check mstruebing/editorconfig-checker + + markdownlint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2.3.3 + - name: markdownlint + run: | + find ~+ ${github_workspace} -name '*.md' | xargs docker run --rm -v ${GITHUB_WORKSPACE}:${GITHUB_WORKSPACE} markdownlint/markdownlint -r ~MD013,~MD033,~MD034 + + yamllint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2.3.3 + - name: yamllint + run: | + find ~+ ${github_workspace} -name '*.yaml' -o -name '*.yml' | xargs docker run --rm -v ${GITHUB_WORKSPACE}:${GITHUB_WORKSPACE} peterdavehello/yamllint yamllint -d '{extends: default, rules: {document-start: {present: false}, line-length: disable}}' diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml new file mode 100644 index 000000000..3dff5f7f4 --- /dev/null +++ b/.github/workflows/mkdocs.yml @@ -0,0 +1,27 @@ +name: Publish docs via GitHub Pages + +on: + push: + branches: + - master + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2.3.3 + + - uses: actions/setup-python@v2.1.4 + with: + python-version: 3.x + + - run: pip install mkdocs-material + - run: pip install mkdocs-redirects + - run: pip install Markdown + - run: pip install Pygments + - run: pip install pymdown-extensions + + - run: cp README.md docs/index.md + + - run: mkdocs gh-deploy --force diff --git a/Bazarr/2to3_language_code.sh b/docs/Bazarr/2to3_language_code.sh similarity index 100% rename from Bazarr/2to3_language_code.sh rename to docs/Bazarr/2to3_language_code.sh diff --git a/Misc/How-to-provide-a-docker-compose-when-you-need-help-on-Discord.md b/docs/Misc/How-to-provide-a-docker-compose-when-you-need-help-on-Discord.md similarity index 100% rename from Misc/How-to-provide-a-docker-compose-when-you-need-help-on-Discord.md rename to docs/Misc/How-to-provide-a-docker-compose-when-you-need-help-on-Discord.md diff --git a/Misc/How-to-setup-Torguard-for-port-forwarding.md b/docs/Misc/How-to-setup-Torguard-for-port-forwarding.md similarity index 100% rename from Misc/How-to-setup-Torguard-for-port-forwarding.md rename to docs/Misc/How-to-setup-Torguard-for-port-forwarding.md diff --git a/Misc/images/image-20200204202420342.png b/docs/Misc/images/image-20200204202420342.png similarity index 100% rename from Misc/images/image-20200204202420342.png rename to docs/Misc/images/image-20200204202420342.png diff --git a/Misc/images/image-20200204205929031.png b/docs/Misc/images/image-20200204205929031.png similarity index 100% rename from Misc/images/image-20200204205929031.png rename to docs/Misc/images/image-20200204205929031.png diff --git a/Misc/images/image-20200204210425170.png b/docs/Misc/images/image-20200204210425170.png similarity index 100% rename from Misc/images/image-20200204210425170.png rename to docs/Misc/images/image-20200204210425170.png diff --git a/Misc/images/image-20200204211350592.png b/docs/Misc/images/image-20200204211350592.png similarity index 100% rename from Misc/images/image-20200204211350592.png rename to docs/Misc/images/image-20200204211350592.png diff --git a/Misc/images/image-20200204211942538.png b/docs/Misc/images/image-20200204211942538.png similarity index 100% rename from Misc/images/image-20200204211942538.png rename to docs/Misc/images/image-20200204211942538.png diff --git a/Misc/images/image-20200204212650314.png b/docs/Misc/images/image-20200204212650314.png similarity index 100% rename from Misc/images/image-20200204212650314.png rename to docs/Misc/images/image-20200204212650314.png diff --git a/Misc/images/image-20200204212748924.png b/docs/Misc/images/image-20200204212748924.png similarity index 100% rename from Misc/images/image-20200204212748924.png rename to docs/Misc/images/image-20200204212748924.png diff --git a/Misc/images/image-20200204215938930.png b/docs/Misc/images/image-20200204215938930.png similarity index 100% rename from Misc/images/image-20200204215938930.png rename to docs/Misc/images/image-20200204215938930.png diff --git a/Misc/images/torguard-FreeTrial-728x90.gif b/docs/Misc/images/torguard-FreeTrial-728x90.gif similarity index 100% rename from Misc/images/torguard-FreeTrial-728x90.gif rename to docs/Misc/images/torguard-FreeTrial-728x90.gif diff --git a/Misc/x265-4k.md b/docs/Misc/x265-4k.md similarity index 100% rename from Misc/x265-4k.md rename to docs/Misc/x265-4k.md diff --git a/NZBGet/How-to-setup-NZBGet.md b/docs/NZBGet/How-to-setup-NZBGet.md similarity index 100% rename from NZBGet/How-to-setup-NZBGet.md rename to docs/NZBGet/How-to-setup-NZBGet.md diff --git a/NZBGet/README.md b/docs/NZBGet/README.md similarity index 100% rename from NZBGet/README.md rename to docs/NZBGet/README.md diff --git a/NZBGet/images/1571588271831.png b/docs/NZBGet/images/1571588271831.png similarity index 100% rename from NZBGet/images/1571588271831.png rename to docs/NZBGet/images/1571588271831.png diff --git a/NZBGet/images/1571593246863.png b/docs/NZBGet/images/1571593246863.png similarity index 100% rename from NZBGet/images/1571593246863.png rename to docs/NZBGet/images/1571593246863.png diff --git a/NZBGet/images/1571593790053.png b/docs/NZBGet/images/1571593790053.png similarity index 100% rename from NZBGet/images/1571593790053.png rename to docs/NZBGet/images/1571593790053.png diff --git a/NZBGet/images/1571593877357.png b/docs/NZBGet/images/1571593877357.png similarity index 100% rename from NZBGet/images/1571593877357.png rename to docs/NZBGet/images/1571593877357.png diff --git a/NZBGet/images/image-20191201110525320.png b/docs/NZBGet/images/image-20191201110525320.png similarity index 100% rename from NZBGet/images/image-20191201110525320.png rename to docs/NZBGet/images/image-20191201110525320.png diff --git a/NZBGet/images/image-20200209125552547.png b/docs/NZBGet/images/image-20200209125552547.png similarity index 100% rename from NZBGet/images/image-20200209125552547.png rename to docs/NZBGet/images/image-20200209125552547.png diff --git a/NZBGet/images/image-20200209130241801.png b/docs/NZBGet/images/image-20200209130241801.png similarity index 100% rename from NZBGet/images/image-20200209130241801.png rename to docs/NZBGet/images/image-20200209130241801.png diff --git a/NZBGet/images/image-20200209130753069.png b/docs/NZBGet/images/image-20200209130753069.png similarity index 100% rename from NZBGet/images/image-20200209130753069.png rename to docs/NZBGet/images/image-20200209130753069.png diff --git a/NZBGet/images/image-20200209131003689.png b/docs/NZBGet/images/image-20200209131003689.png similarity index 100% rename from NZBGet/images/image-20200209131003689.png rename to docs/NZBGet/images/image-20200209131003689.png diff --git a/NZBGet/scripts/Clean/Clean.py b/docs/NZBGet/scripts/Clean/Clean.py similarity index 100% rename from NZBGet/scripts/Clean/Clean.py rename to docs/NZBGet/scripts/Clean/Clean.py diff --git a/NZBGet/scripts/Clean/README.md b/docs/NZBGet/scripts/Clean/README.md similarity index 100% rename from NZBGet/scripts/Clean/README.md rename to docs/NZBGet/scripts/Clean/README.md diff --git a/NZBGet/scripts/HashRenamer/HashRenamer.py b/docs/NZBGet/scripts/HashRenamer/HashRenamer.py similarity index 100% rename from NZBGet/scripts/HashRenamer/HashRenamer.py rename to docs/NZBGet/scripts/HashRenamer/HashRenamer.py diff --git a/NZBGet/scripts/HashRenamer/README.md b/docs/NZBGet/scripts/HashRenamer/README.md similarity index 100% rename from NZBGet/scripts/HashRenamer/README.md rename to docs/NZBGet/scripts/HashRenamer/README.md diff --git a/NZBGet/scripts/README.md b/docs/NZBGet/scripts/README.md similarity index 100% rename from NZBGet/scripts/README.md rename to docs/NZBGet/scripts/README.md diff --git a/NZBGet/scripts/WtFnZb-Renamer/README.md b/docs/NZBGet/scripts/WtFnZb-Renamer/README.md similarity index 100% rename from NZBGet/scripts/WtFnZb-Renamer/README.md rename to docs/NZBGet/scripts/WtFnZb-Renamer/README.md diff --git a/NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py b/docs/NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py similarity index 100% rename from NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py rename to docs/NZBGet/scripts/WtFnZb-Renamer/WtFnZb-Renamer.py diff --git a/Plex/Profiles/Android-SHIELD/Android-SHIELD Android TV.xml b/docs/Plex/Profiles/Android-SHIELD/Android-SHIELD Android TV.xml similarity index 100% rename from Plex/Profiles/Android-SHIELD/Android-SHIELD Android TV.xml rename to docs/Plex/Profiles/Android-SHIELD/Android-SHIELD Android TV.xml diff --git a/Plex/Profiles/Chromecast/Chromecast.xml b/docs/Plex/Profiles/Chromecast/Chromecast.xml similarity index 100% rename from Plex/Profiles/Chromecast/Chromecast.xml rename to docs/Plex/Profiles/Chromecast/Chromecast.xml diff --git a/Plex/Profiles/README.md b/docs/Plex/Profiles/README.md similarity index 100% rename from Plex/Profiles/README.md rename to docs/Plex/Profiles/README.md diff --git a/Plex/README.md b/docs/Plex/README.md similarity index 100% rename from Plex/README.md rename to docs/Plex/README.md diff --git a/Radarr/Collection-of-Custom-Formats-for-Radarr.md b/docs/Radarr/Collection-of-Custom-Formats-for-Radarr.md similarity index 100% rename from Radarr/Collection-of-Custom-Formats-for-Radarr.md rename to docs/Radarr/Collection-of-Custom-Formats-for-Radarr.md diff --git a/Radarr/How-to-get-Quality-Releases.md b/docs/Radarr/How-to-get-Quality-Releases.md similarity index 100% rename from Radarr/How-to-get-Quality-Releases.md rename to docs/Radarr/How-to-get-Quality-Releases.md diff --git a/Radarr/How-to-make-sure-Radarr-doesnt-snatch-Full-BluRays.md b/docs/Radarr/How-to-make-sure-Radarr-doesnt-snatch-Full-BluRays.md similarity index 100% rename from Radarr/How-to-make-sure-Radarr-doesnt-snatch-Full-BluRays.md rename to docs/Radarr/How-to-make-sure-Radarr-doesnt-snatch-Full-BluRays.md diff --git a/Radarr/Remote-Path-Mappings-explained-for-Radarr.md b/docs/Radarr/Remote-Path-Mappings-explained-for-Radarr.md similarity index 100% rename from Radarr/Remote-Path-Mappings-explained-for-Radarr.md rename to docs/Radarr/Remote-Path-Mappings-explained-for-Radarr.md diff --git a/Radarr/images/animated-exclamation-mark-image-0003.gif b/docs/Radarr/images/animated-exclamation-mark-image-0003.gif similarity index 100% rename from Radarr/images/animated-exclamation-mark-image-0003.gif rename to docs/Radarr/images/animated-exclamation-mark-image-0003.gif diff --git a/Radarr/images/animated-exclamation-mark-image-0006-1581778299523.gif b/docs/Radarr/images/animated-exclamation-mark-image-0006-1581778299523.gif similarity index 100% rename from Radarr/images/animated-exclamation-mark-image-0006-1581778299523.gif rename to docs/Radarr/images/animated-exclamation-mark-image-0006-1581778299523.gif diff --git a/Radarr/images/animated-exclamation-mark-image-0006.gif b/docs/Radarr/images/animated-exclamation-mark-image-0006.gif similarity index 100% rename from Radarr/images/animated-exclamation-mark-image-0006.gif rename to docs/Radarr/images/animated-exclamation-mark-image-0006.gif diff --git a/Radarr/images/image-20191027165122728.png b/docs/Radarr/images/image-20191027165122728.png similarity index 100% rename from Radarr/images/image-20191027165122728.png rename to docs/Radarr/images/image-20191027165122728.png diff --git a/Radarr/images/image-20191027165328556.png b/docs/Radarr/images/image-20191027165328556.png similarity index 100% rename from Radarr/images/image-20191027165328556.png rename to docs/Radarr/images/image-20191027165328556.png diff --git a/Radarr/images/image-20191027165508102.png b/docs/Radarr/images/image-20191027165508102.png similarity index 100% rename from Radarr/images/image-20191027165508102.png rename to docs/Radarr/images/image-20191027165508102.png diff --git a/Radarr/images/image-20191027170313598.png b/docs/Radarr/images/image-20191027170313598.png similarity index 100% rename from Radarr/images/image-20191027170313598.png rename to docs/Radarr/images/image-20191027170313598.png diff --git a/Radarr/images/image-20200209165701743.png b/docs/Radarr/images/image-20200209165701743.png similarity index 100% rename from Radarr/images/image-20200209165701743.png rename to docs/Radarr/images/image-20200209165701743.png diff --git a/Radarr/images/image-20200307121133057.png b/docs/Radarr/images/image-20200307121133057.png similarity index 100% rename from Radarr/images/image-20200307121133057.png rename to docs/Radarr/images/image-20200307121133057.png diff --git a/Radarr/images/image-20200307121221123.png b/docs/Radarr/images/image-20200307121221123.png similarity index 100% rename from Radarr/images/image-20200307121221123.png rename to docs/Radarr/images/image-20200307121221123.png diff --git a/Radarr/images/image-20200307121316716.png b/docs/Radarr/images/image-20200307121316716.png similarity index 100% rename from Radarr/images/image-20200307121316716.png rename to docs/Radarr/images/image-20200307121316716.png diff --git a/Radarr/images/image-20200307121406542.png b/docs/Radarr/images/image-20200307121406542.png similarity index 100% rename from Radarr/images/image-20200307121406542.png rename to docs/Radarr/images/image-20200307121406542.png diff --git a/Radarr/images/image-20200307121755593.png b/docs/Radarr/images/image-20200307121755593.png similarity index 100% rename from Radarr/images/image-20200307121755593.png rename to docs/Radarr/images/image-20200307121755593.png diff --git a/Radarr/images/image-20200307121910786.png b/docs/Radarr/images/image-20200307121910786.png similarity index 100% rename from Radarr/images/image-20200307121910786.png rename to docs/Radarr/images/image-20200307121910786.png diff --git a/Radarr/images/image-20200307123131923.png b/docs/Radarr/images/image-20200307123131923.png similarity index 100% rename from Radarr/images/image-20200307123131923.png rename to docs/Radarr/images/image-20200307123131923.png diff --git a/Radarr/images/image-20200307123344848.png b/docs/Radarr/images/image-20200307123344848.png similarity index 100% rename from Radarr/images/image-20200307123344848.png rename to docs/Radarr/images/image-20200307123344848.png diff --git a/Radarr/images/image-20200307123503158.png b/docs/Radarr/images/image-20200307123503158.png similarity index 100% rename from Radarr/images/image-20200307123503158.png rename to docs/Radarr/images/image-20200307123503158.png diff --git a/Radarr/images/image-20200517185154185.png b/docs/Radarr/images/image-20200517185154185.png similarity index 100% rename from Radarr/images/image-20200517185154185.png rename to docs/Radarr/images/image-20200517185154185.png diff --git a/Radarr/images/image-20200517185901176.png b/docs/Radarr/images/image-20200517185901176.png similarity index 100% rename from Radarr/images/image-20200517185901176.png rename to docs/Radarr/images/image-20200517185901176.png diff --git a/Radarr/images/image-20200517190028898.png b/docs/Radarr/images/image-20200517190028898.png similarity index 100% rename from Radarr/images/image-20200517190028898.png rename to docs/Radarr/images/image-20200517190028898.png diff --git a/RadarrV3/Collection-of-Custom-Formats-for-RadarrV3.md b/docs/RadarrV3/Collection-of-Custom-Formats-for-RadarrV3.md similarity index 100% rename from RadarrV3/Collection-of-Custom-Formats-for-RadarrV3.md rename to docs/RadarrV3/Collection-of-Custom-Formats-for-RadarrV3.md diff --git a/RadarrV3/How-to-importexport-Custom-Formats-and-truly-make-use-of-it.md b/docs/RadarrV3/How-to-importexport-Custom-Formats-and-truly-make-use-of-it.md similarity index 100% rename from RadarrV3/How-to-importexport-Custom-Formats-and-truly-make-use-of-it.md rename to docs/RadarrV3/How-to-importexport-Custom-Formats-and-truly-make-use-of-it.md diff --git a/RadarrV3/Radarr-Quality-Settings-File-Size.md b/docs/RadarrV3/Radarr-Quality-Settings-File-Size.md similarity index 100% rename from RadarrV3/Radarr-Quality-Settings-File-Size.md rename to docs/RadarrV3/Radarr-Quality-Settings-File-Size.md diff --git a/RadarrV3/Radarr-recommended-naming-scheme-examples.md b/docs/RadarrV3/Radarr-recommended-naming-scheme-examples.md similarity index 100% rename from RadarrV3/Radarr-recommended-naming-scheme-examples.md rename to docs/RadarrV3/Radarr-recommended-naming-scheme-examples.md diff --git a/RadarrV3/images/image-20200926105858168.png b/docs/RadarrV3/images/image-20200926105858168.png similarity index 100% rename from RadarrV3/images/image-20200926105858168.png rename to docs/RadarrV3/images/image-20200926105858168.png diff --git a/RadarrV3/images/image-20200926110018973.png b/docs/RadarrV3/images/image-20200926110018973.png similarity index 100% rename from RadarrV3/images/image-20200926110018973.png rename to docs/RadarrV3/images/image-20200926110018973.png diff --git a/RadarrV3/images/image-20200926110122043.png b/docs/RadarrV3/images/image-20200926110122043.png similarity index 100% rename from RadarrV3/images/image-20200926110122043.png rename to docs/RadarrV3/images/image-20200926110122043.png diff --git a/RadarrV3/images/image-20200926110751639.png b/docs/RadarrV3/images/image-20200926110751639.png similarity index 100% rename from RadarrV3/images/image-20200926110751639.png rename to docs/RadarrV3/images/image-20200926110751639.png diff --git a/RadarrV3/images/image-20200926111254181.png b/docs/RadarrV3/images/image-20200926111254181.png similarity index 100% rename from RadarrV3/images/image-20200926111254181.png rename to docs/RadarrV3/images/image-20200926111254181.png diff --git a/RadarrV3/images/image-20200926113435255.png b/docs/RadarrV3/images/image-20200926113435255.png similarity index 100% rename from RadarrV3/images/image-20200926113435255.png rename to docs/RadarrV3/images/image-20200926113435255.png diff --git a/RadarrV3/images/image-20200926114854509.png b/docs/RadarrV3/images/image-20200926114854509.png similarity index 100% rename from RadarrV3/images/image-20200926114854509.png rename to docs/RadarrV3/images/image-20200926114854509.png diff --git a/RadarrV3/images/image-20200926114938367.png b/docs/RadarrV3/images/image-20200926114938367.png similarity index 100% rename from RadarrV3/images/image-20200926114938367.png rename to docs/RadarrV3/images/image-20200926114938367.png diff --git a/RadarrV3/images/image-20200926115916590.png b/docs/RadarrV3/images/image-20200926115916590.png similarity index 100% rename from RadarrV3/images/image-20200926115916590.png rename to docs/RadarrV3/images/image-20200926115916590.png diff --git a/RadarrV3/images/image-20200926120736230.png b/docs/RadarrV3/images/image-20200926120736230.png similarity index 100% rename from RadarrV3/images/image-20200926120736230.png rename to docs/RadarrV3/images/image-20200926120736230.png diff --git a/RadarrV3/images/image-20201007190601478.png b/docs/RadarrV3/images/image-20201007190601478.png similarity index 100% rename from RadarrV3/images/image-20201007190601478.png rename to docs/RadarrV3/images/image-20201007190601478.png diff --git a/SonarrV2/How-To-Seperate-Different-WEB-DL-Releases.md b/docs/SonarrV2/How-To-Seperate-Different-WEB-DL-Releases.md similarity index 100% rename from SonarrV2/How-To-Seperate-Different-WEB-DL-Releases.md rename to docs/SonarrV2/How-To-Seperate-Different-WEB-DL-Releases.md diff --git a/SonarrV2/Restrictions-For-Better-Quality-Releases.md b/docs/SonarrV2/Restrictions-For-Better-Quality-Releases.md similarity index 100% rename from SonarrV2/Restrictions-For-Better-Quality-Releases.md rename to docs/SonarrV2/Restrictions-For-Better-Quality-Releases.md diff --git a/SonarrV3/README.md b/docs/SonarrV3/README.md similarity index 100% rename from SonarrV3/README.md rename to docs/SonarrV3/README.md diff --git a/SonarrV3/Remote-Path-Mappings-explained-for-Sonarr.md b/docs/SonarrV3/Remote-Path-Mappings-explained-for-Sonarr.md similarity index 100% rename from SonarrV3/Remote-Path-Mappings-explained-for-Sonarr.md rename to docs/SonarrV3/Remote-Path-Mappings-explained-for-Sonarr.md diff --git a/SonarrV3/Sonarr-Quality-Settings-File-Size.md b/docs/SonarrV3/Sonarr-Quality-Settings-File-Size.md similarity index 100% rename from SonarrV3/Sonarr-Quality-Settings-File-Size.md rename to docs/SonarrV3/Sonarr-Quality-Settings-File-Size.md diff --git a/SonarrV3/Sonarr-Release-Profile-RegEx.md b/docs/SonarrV3/Sonarr-Release-Profile-RegEx.md similarity index 100% rename from SonarrV3/Sonarr-Release-Profile-RegEx.md rename to docs/SonarrV3/Sonarr-Release-Profile-RegEx.md diff --git a/SonarrV3/Sonarr-recommended-naming-scheme-examples.md b/docs/SonarrV3/Sonarr-recommended-naming-scheme-examples.md similarity index 100% rename from SonarrV3/Sonarr-recommended-naming-scheme-examples.md rename to docs/SonarrV3/Sonarr-recommended-naming-scheme-examples.md diff --git a/SonarrV3/images/1549734647618.png b/docs/SonarrV3/images/1549734647618.png similarity index 100% rename from SonarrV3/images/1549734647618.png rename to docs/SonarrV3/images/1549734647618.png diff --git a/SonarrV3/images/1549734726771.png b/docs/SonarrV3/images/1549734726771.png similarity index 100% rename from SonarrV3/images/1549734726771.png rename to docs/SonarrV3/images/1549734726771.png diff --git a/SonarrV3/images/1549734875590.png b/docs/SonarrV3/images/1549734875590.png similarity index 100% rename from SonarrV3/images/1549734875590.png rename to docs/SonarrV3/images/1549734875590.png diff --git a/SonarrV3/images/1549734928236.png b/docs/SonarrV3/images/1549734928236.png similarity index 100% rename from SonarrV3/images/1549734928236.png rename to docs/SonarrV3/images/1549734928236.png diff --git a/SonarrV3/images/1549734986119.png b/docs/SonarrV3/images/1549734986119.png similarity index 100% rename from SonarrV3/images/1549734986119.png rename to docs/SonarrV3/images/1549734986119.png diff --git a/SonarrV3/images/1549735082937.png b/docs/SonarrV3/images/1549735082937.png similarity index 100% rename from SonarrV3/images/1549735082937.png rename to docs/SonarrV3/images/1549735082937.png diff --git a/SonarrV3/images/1549735142149.png b/docs/SonarrV3/images/1549735142149.png similarity index 100% rename from SonarrV3/images/1549735142149.png rename to docs/SonarrV3/images/1549735142149.png diff --git a/SonarrV3/images/1571573554399.png b/docs/SonarrV3/images/1571573554399.png similarity index 100% rename from SonarrV3/images/1571573554399.png rename to docs/SonarrV3/images/1571573554399.png diff --git a/SonarrV3/images/1571575011671.png b/docs/SonarrV3/images/1571575011671.png similarity index 100% rename from SonarrV3/images/1571575011671.png rename to docs/SonarrV3/images/1571575011671.png diff --git a/SonarrV3/images/animated-exclamation-mark-image-0006-1581778210859.gif b/docs/SonarrV3/images/animated-exclamation-mark-image-0006-1581778210859.gif similarity index 100% rename from SonarrV3/images/animated-exclamation-mark-image-0006-1581778210859.gif rename to docs/SonarrV3/images/animated-exclamation-mark-image-0006-1581778210859.gif diff --git a/SonarrV3/images/animated-exclamation-mark-image-0006.gif b/docs/SonarrV3/images/animated-exclamation-mark-image-0006.gif similarity index 100% rename from SonarrV3/images/animated-exclamation-mark-image-0006.gif rename to docs/SonarrV3/images/animated-exclamation-mark-image-0006.gif diff --git a/SonarrV3/images/image-20200930190924569.png b/docs/SonarrV3/images/image-20200930190924569.png similarity index 100% rename from SonarrV3/images/image-20200930190924569.png rename to docs/SonarrV3/images/image-20200930190924569.png diff --git a/SonarrV3/images/image-20200930194224862.png b/docs/SonarrV3/images/image-20200930194224862.png similarity index 100% rename from SonarrV3/images/image-20200930194224862.png rename to docs/SonarrV3/images/image-20200930194224862.png diff --git a/SonarrV3/images/image-20201004135035478.png b/docs/SonarrV3/images/image-20201004135035478.png similarity index 100% rename from SonarrV3/images/image-20201004135035478.png rename to docs/SonarrV3/images/image-20201004135035478.png diff --git a/SonarrV3/images/image-20201010205202708.png b/docs/SonarrV3/images/image-20201010205202708.png similarity index 100% rename from SonarrV3/images/image-20201010205202708.png rename to docs/SonarrV3/images/image-20201010205202708.png diff --git a/SonarrV3/images/image-20201011124833659.png b/docs/SonarrV3/images/image-20201011124833659.png similarity index 100% rename from SonarrV3/images/image-20201011124833659.png rename to docs/SonarrV3/images/image-20201011124833659.png diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..4613ef83b --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,33 @@ +--- +site_name: Tutorials-FAQ +site_description: Here you will find a collection of Setup Guides, Tips and Scripts that I've made/collected. +site_author: TRaSH- +site_url: https://TRaSH-.github.io/Tutorials-FAQ + +repo_url: https://github.com/TRaSH-/Tutorials-FAQ +repo_name: TRaSH-/Tutorials-FAQ + +copyright: Copyright © 2020 TRaSH- + +extra: + manifest: manifest.webmanifest + +markdown_extensions: + - pymdownx.keys + - pymdownx.snippets + - pymdownx.superfences + - toc: + permalink: true + +plugins: + - search + +theme: + name: material + features: + - navigation.instant + language: en + palette: + primary: grey + accent: red + scheme: slate