Docs: update (#599)

.github/workflows/pages.yml

@@ -35,8 +35,14 @@ jobs:
         with:
           key: ${{ github.ref }}
           path: .cache
-      - run: pip install mkdocs-material
-      - run: pip install mkdocs-git-revision-date-localized-plugin mkdocs-redirects mkdocs-htmlproofer-plugin mdx_truly_sane_lists
+      - run: |
+          pip install mkdocs-material
+          pip install \
+            mkdocs-exclude-search \
+            mkdocs-git-revision-date-localized-plugin \
+            mkdocs-redirects \
+            mkdocs-htmlproofer-plugin \
+            mdx_truly_sane_lists
       - run: |
           pip install pillow cairosvg
           sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
@@ -71,8 +77,14 @@ jobs:
         with:
           key: ${{ github.ref }}
           path: .cache
-      - run: pip install mkdocs-material
-      - run: pip install mkdocs-git-revision-date-localized-plugin mkdocs-redirects mkdocs-htmlproofer-plugin mdx_truly_sane_lists
+      - run: |
+          pip install mkdocs-material
+          pip install \
+            mkdocs-exclude-search \
+            mkdocs-git-revision-date-localized-plugin \
+            mkdocs-redirects \
+            mkdocs-htmlproofer-plugin \
+            mdx_truly_sane_lists
       - run: |
           pip install pillow cairosvg
           sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev

README.md

@@ -3,7 +3,7 @@
 <p align="center"><b>Pronounced "eager," <code>igir</code> is a video game ROM collection manager to help filter, sort, patch, archive, and report on collections on any OS.</b></p>
 
 <p align="center">
-  <a href="https://github.com/emmercm/igir#readme"><img alt="CLI: Windows,macOS,Linux" src="https://img.shields.io/badge/CLI-Windows%2C%20macOS%2C%20Linux-lightgrey?logo=windows-terminal"></a>
+  <a href="https://igir.io/"><img alt="CLI: Windows,macOS,Linux" src="https://img.shields.io/badge/CLI-Windows%2C%20macOS%2C%20Linux-lightgrey?logo=windows-terminal"></a>
   <a href="https://www.npmjs.com/package/igir"><img alt="npm: version" src="https://img.shields.io/npm/v/igir?color=%23cc3534&label=version&logo=npm&logoColor=white"></a>
   <a href="https://www.npmjs.com/package/igir"><img alt="npm: downloads" src="https://img.shields.io/npm/dt/igir?color=%23cc3534&logo=npm&logoColor=white"></a>
   <a href="https://github.com/emmercm/igir/releases"><img alt="GitHub: downloads" src="https://img.shields.io/github/downloads/emmercm/igir/total?color=%236e5494&logo=github&logoColor=white"></a>

docs/installation.md

@@ -56,7 +56,7 @@ If none of the above options work for you, [Docker](https://www.docker.com/) may
       --volume "%cd%:\pwd" ^
       --workdir "/pwd" ^
       node:lts ^
-      npx igir@latest copy zip --dat "*.dat" --input ROMs/ --output ROMs-Sorted/ --dir-dat-name
+      npx igir@latest copy zip --dat "*.dat" --input ROMs\ --output ROMs-Sorted\ --dir-dat-name
     ```
 
 === ":simple-apple: macOS"

docs/output/reporting.md

@@ -60,17 +60,25 @@ The report output filename supports a version of [Moment.js symbols](https://mom
 
     See the [Moment.js docs](https://momentjs.com/docs/#/displaying/) for a complete list of tokens you can use.
 
+!!! warning
+
+    The `%` character is used to denote replaceable variable names (such as `%USERPROFILE%` and `%TEMP%`) in Windows Batch scripting. You may need to "escape" `%` characters with a `^` if you experience problems. Example:
+
+    ```text
+    --report-output ^%X.csv
+    ```
+
 Here are some example usages:
 
 === ":simple-windowsxp: Windows"
 
     ```batch
     > igir.exe report --dat *.dat --input ROMs\ --report-output ".\report.csv"
 
-    > igir.exe report --dat *.dat --input ROMs/ --report-output "./report %dddd, %MMMM %Do %YYYY, %h:%mm:%ss %a.csv"
+    > igir.exe report --dat *.dat --input ROMs\ --report-output ".\report %dddd, %MMMM %Do %YYYY, %h:%mm:%ss %a.csv"
     REM ./report Friday, April 14th 2023, 4:28:26 pm.csv
 
-    > igir.exe report --dat *.dat --input ROMs/ --report-output "/igir/%X.csv"
+    > igir.exe report --dat *.dat --input ROMs\ --report-output "igir\%X.csv"
     REM /igir/1681515048.csv
     ```
 
@@ -82,7 +90,7 @@ Here are some example usages:
     $ igir report --dat *.dat --input ROMs/ --report-output "./report %dddd, %MMMM %Do %YYYY, %h:%mm:%ss %a.csv"
     # ./report Friday, April 14th 2023, 4:28:26 pm.csv
 
-    $ igir report --dat *.dat --input ROMs/ --report-output "/igir/%X.csv"
+    $ igir report --dat *.dat --input ROMs/ --report-output "igir\%X.csv"
     # /igir/1681515048.csv
     ```
 
@@ -94,6 +102,6 @@ Here are some example usages:
     $ igir report --dat *.dat --input ROMs/ --report-output "./report %dddd, %MMMM %Do %YYYY, %h:%mm:%ss %a.csv"
     # ./report Friday, April 14th 2023, 4:28:26 pm.csv
 
-    $ igir report --dat *.dat --input ROMs/ --report-output "/igir/%X.csv"
+    $ igir report --dat *.dat --input ROMs/ --report-output "igir/%X.csv"
     # /igir/1681515048.csv
     ```

docs/usage/desktop/batocera.md

@@ -19,7 +19,7 @@ Because Batocera uses RetroArch under the hood, the instructions are generally t
 
 ## ROMs
 
-Batocera has a `roms` folder in the "userdata partition" at `/userdata/roms` that is used by default:
+Batocera uses its own proprietary [ROM folder structure](https://wiki.batocera.org/systems), so `igir` has a replaceable `{batocera}` token to sort ROMs into the right place. See the [replaceable tokens page](../../output/tokens.md) for more information.
 
 === ":simple-linux: Batocera (Linux)"
 

docs/usage/desktop/retroarch.md

@@ -65,7 +65,7 @@ If you want to store your ROMs in the RetroArch folder, you could co-locate them
     ```batch
     igir copy zip test ^
       --dat "No-Intro*.zip" ^
-      --input ROMs/ ^
+      --input ROMs\ ^
       --output C:\RetroArch-Win64\roms ^
       --dir-dat-name ^
       --no-bios
@@ -78,7 +78,7 @@ If you want to store your ROMs in the RetroArch folder, you could co-locate them
     ```batch
     igir copy zip test ^
       --dat "No-Intro*.zip" ^
-      --input ROMs/ ^
+      --input ROMs\ ^
       --output C:\RetroArch-Win32\roms ^
       --dir-dat-name ^
       --no-bios

mkdocs.yml

@@ -29,7 +29,9 @@ theme:
     - navigation.tabs.sticky
     - navigation.indexes
     - navigation.sections
+    - navigation.path
     - navigation.instant
+    - navigation.instant.prefetch
     - navigation.footer
     - toc.follow
     - toc.integrate
@@ -38,8 +40,9 @@ theme:
     - content.tabs.link
 
 nav:
-  - Home: index.md
   - Documentation:
+      - Home:
+        - index.md
       - overview.md
       - installation.md
       - commands.md
@@ -88,10 +91,15 @@ nav:
   - Discuss ↗: https://github.com/emmercm/igir/discussions" target="_blank
 
 plugins:
-  - search
+  - search:
+      lang: en
+  - exclude-search:
+      exclude:
+        - index.md
+      exclude_unreferenced: true
   - social
   - git-revision-date-localized:
-      enable_creation_date: true
+      enable_creation_date: false
   - redirects:
       redirect_maps:
         'archives.md': 'input/reading-archives.md'