Added mkdocs-redirects, tabs due to more main

synshop · Sep 30, 2024 · 7ecb310 · 7ecb310
1 parent 64a8652
commit 7ecb310
Show file tree

Hide file tree

Showing 4 changed files with 99 additions and 5 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,6 +15,7 @@ jobs:
       - run: pip install "mkdocs-material[imaging]"
       - run: pip install mkdocs-mermaid2-plugin
       - run: pip install mkdocs-awesome-pages-plugin
+      - run: pip install mkdocs-redirects
       - run: mkdir local_public
       - run: mkdocs build --clean -d ./local_public/
 

diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,6 @@ docs/.DS_Store
 .DS_Store
 .venv*
 venv
-activate
+activate
+key_value_pairs.txt
+old_file_names.txt
diff --git a/docs/index.md b/docs/index.md
@@ -27,7 +27,7 @@ It's encouraged to contribute to RTFM to help improve RTFM's organization and av
 ### What help do we need?
 Here are some common ways you can help rtfm:
 
-* Filling [STUB articles](https://rtfm.synshop.org/tags/#stub) with more information.   
+* Filling [STUB articles](tags/#stub) with more information.
 
 * Improve the style of pages so it conforms to the [Manual of Style](editors). This can include:
 
@@ -40,10 +40,10 @@ Here are some common ways you can help rtfm:
 
 There are 4 ways to get engaged with SYN Shop RTFM:
 
-* Message the #rtfm channel on discord to discuss various improvements. Discord link at https://synshop.org/discord
+* Message the `#rtfm` channel on discord to discuss various improvements. Discord link at [https://synshop.org/discord](https://synshop.org/discord)
 
 * Create an [issue on github](https://github.com/synshop/rtfm/issues/new).
 
-* Fork https://github.com/synshop/rtfm and make a pull request.  
+* Fork [https://github.com/synshop/rtfm](https://github.com/synshop/rtfm) and make a pull request.
 
-* Ask an RTFM admin for contributor access and contribute directly on github. (members only)
+* Ask an RTFM admin for contributor access and edit directly on github. (members only)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,7 +6,11 @@ theme:
     - content.action.edit
     - content.action.view
     - navigation.instant
+    - navigation.instant.progress
     - navigation.indexes
+    - navigation.sections
+    - navigation.tabs
+    - navigation.tabs.sticky
     - navigation.top
     - search.highlight
     - search.suggest
@@ -57,3 +61,90 @@ plugins:
     - tags:
          tags_file: tags.md
     - mermaid2
+# Redirects
+    - redirects
+        - redirect_maps:
+           'docs/members/About SYN Shop/SYN Shop 1.0.md': 'docs/About SYN Shop/SYN Shop 1.0.md'
+           'docs/members/About SYN Shop/SYN Shop 3.0/FAQ.md': 'docs/About SYN Shop/SYN Shop 3.0/FAQ.md'
+           'docs/members/About SYN Shop/SYN Shop 3.0/index.md': 'docs/About SYN Shop/SYN Shop 3.0/index.md'
+           'docs/members/Documents/Logos.md': 'docs/Documents/Logos.md'
+           'docs/members/Documents/Waivers.md': 'docs/Documents/Waivers.md'
+           'docs/members/Equipment/3D Printing/F400-s.md': 'docs/Equipment/3D Printing/F400-s.md'
+           'docs/members/Equipment/3D Printing/Resin Printers.md': 'docs/Equipment/3D Printing/Resin Printers.md'
+           'docs/members/Equipment/3D Printing/index.md': 'docs/Equipment/3D Printing/index.md'
+           'docs/members/Equipment/Crafts/Industrial Sewing Maching.md': 'docs/Equipment/Crafts/Industrial Sewing Maching.md'
+           'docs/members/Equipment/Crafts/Vinyl Cutter.md': 'docs/Equipment/Crafts/Vinyl Cutter.md'
+           'docs/members/Equipment/Crafts/index.md': 'docs/Equipment/Crafts/index.md'
+           'docs/members/Equipment/Danger Room/Band Saw.md': 'docs/Equipment/Danger Room/Band Saw.md'
+           'docs/members/Equipment/Danger Room/Drill Press.md': 'docs/Equipment/Danger Room/Drill Press.md'
+           'docs/members/Equipment/Danger Room/Jointer.md': 'docs/Equipment/Danger Room/Jointer.md'
+           'docs/members/Equipment/Danger Room/ShopBot.md': 'docs/Equipment/Danger Room/ShopBot.md'
+           'docs/members/Equipment/Danger Room/Surface Planer.md': 'docs/Equipment/Danger Room/Surface Planer.md'
+           'docs/members/Equipment/Danger Room/Table Saw.md': 'docs/Equipment/Danger Room/Table Saw.md'
+           'docs/members/Equipment/Danger Room/Track Saw.md': 'docs/Equipment/Danger Room/Track Saw.md'
+           'docs/members/Equipment/Danger Room/index.md': 'docs/Equipment/Danger Room/index.md'
+           'docs/members/Equipment/Electronics/Category III Multimeter.md': 'docs/Equipment/Electronics/Category III Multimeter.md'
+           'docs/members/Equipment/Electronics/Digital Oscilloscope.md': 'docs/Equipment/Electronics/Digital Oscilloscope.md'
+           'docs/members/Equipment/Electronics/Function Generator.md': 'docs/Equipment/Electronics/Function Generator.md'
+           'docs/members/Equipment/Electronics/LCR Meter.md': 'docs/Equipment/Electronics/LCR Meter.md'
+           'docs/members/Equipment/Electronics/Power Supply.md': 'docs/Equipment/Electronics/Power Supply.md'
+           'docs/members/Equipment/Electronics/SMT Soldering Oven.md': 'docs/Equipment/Electronics/SMT Soldering Oven.md'
+           'docs/members/Equipment/Electronics/index.md': 'docs/Equipment/Electronics/index.md'
+           'docs/members/Equipment/Laser Cutting/Big Boi Laser Cutter.md': 'docs/Equipment/Laser Cutting/Big Boi Laser Cutter.md'
+           'docs/members/Equipment/Laser Cutting/First Child Laser Cutter.md': 'docs/Equipment/Laser Cutting/First Child Laser Cutter.md'
+           'docs/members/Equipment/Print and Office/Garment Printer.md': 'docs/Equipment/Print and Office/Garment Printer.md'
+           'docs/members/Equipment/Print and Office/Large Format Laminator.md': 'docs/Equipment/Print and Office/Large Format Laminator.md'
+           'docs/members/Equipment/Print and Office/Large Format Printer.md': 'docs/Equipment/Print and Office/Large Format Printer.md'
+           'docs/members/Equipment/Print and Office/Multi-Function Printer.md': 'docs/Equipment/Print and Office/Multi-Function Printer.md'
+           'docs/members/Equipment/Print and Office/P-Touch Label Maker.md': 'docs/Equipment/Print and Office/P-Touch Label Maker.md'
+           'docs/members/Equipment/Print and Office/index.md': 'docs/Equipment/Print and Office/index.md'
+           'docs/members/Equipment/index.md': 'docs/Equipment/index.md'
+           'docs/members/FAQ.md': 'docs/FAQ.md'
+           'docs/members/Projects/Individual/index.md': 'docs/Projects/Individual/index.md'
+           'docs/members/Projects/Shop/555 Contest - Gravity Detecting, Color Swirling Pingpong Balls.md': 'docs/Projects/Shop/555 Contest - Gravity Detecting, Color Swirling Pingpong Balls.md'
+           'docs/members/Projects/Shop/Do-nato.md': 'docs/Projects/Shop/Do-nato.md'
+           'docs/members/Projects/Shop/Shapeoko PCB Milling.md': 'docs/Projects/Shop/Shapeoko PCB Milling.md'
+           'docs/members/Projects/Shop/Traffic-Light.md': 'docs/Projects/Shop/Traffic-Light.md'
+           'docs/members/Resources/Local Resources.md': 'docs/Resources/Local Resources.md'
+           'docs/members/Resources/Mailing Lists.md': 'docs/Resources/Mailing Lists.md'
+           'docs/members/Resources/Online Resources.md': 'docs/Resources/Online Resources.md'
+           'docs/members/Resources/Shop Network.md': 'docs/Resources/Shop Network.md'
+           'docs/members/Resources/index.md': 'docs/Resources/index.md'
+           'docs/members/Software/DTGRIP.md': 'docs/Software/DTGRIP.md'
+           'docs/members/Software/Retina Engrave.md': 'docs/Software/Retina Engrave.md'
+           'docs/members/kiosk.md': 'docs/kiosk.md'
+           'docs/members/SYN Shop Tool List.md': 'docs/members/Equipment/index.md'
+           'docs/members/Projects/555 Contest - Gravity Detecting, Color Swirling Pingpong Balls.md': 'docs/members/Projects/Shop/555 Contest - Gravity Detecting, Color Swirling Pingpong Balls.md'
+           'docs/members/Projects/Do-nato.md': 'docs/members/Projects/Shop/Do-nato.md'
+           'docs/members/Projects/Shapeoko PCB Milling.md': 'docs/members/Projects/Shop/Shapeoko PCB Milling.md'
+           'docs/members/Projects/Traffic-Light.md': 'docs/members/Projects/Shop/Traffic-Light.md'
+           'docs/users/Equipment/F400-s.md': 'docs/users/Equipment/3D Printing/F400-s.md'
+           'docs/users/About SYN Shop/SYN Shop Vision.md': 'docs/SYN Shop Vision.md'
+           'docs/editors/equipment_template.md': 'docs/editors/Templates/equipment_template.md'
+           'docs/Manual of Style.md': 'docs/editors/Manual of Style.md'
+           'docs/users/Equipment/equipment_template.md': 'docs/editors/equipment_template.md'
+           'docs/users/Logos.md': 'docs/users/Documents/Logos.md'
+           'docs/users/Waivers.md': 'docs/users/Documents/Waivers.md'
+           'docs/users/Local Resources.md': 'docs/users/Resources/Local Resources.md'
+           'docs/users/Mailing Lists.md': 'docs/users/Resources/Mailing Lists.md'
+           'docs/users/Online Resources.md': 'docs/users/Resources/Online Resources.md'
+           'docs/users/Shop Network.md': 'docs/users/Resources/Shop Network.md'
+           'docs/users/Equipment/Resin Printers.md': 'docs/users/Equipment/3D Printing/Resin Printers.md'
+           'docs/users/Equipment/Consew 230 Industrial Sewing Machine.md': 'docs/users/Equipment/Crafts/Industrial Sewing Maching.md'
+           'docs/users/Equipment/Silhoutte Cameo.md': 'docs/users/Equipment/Crafts/Vinyl Cutter.md'
+           'docs/users/Equipment/Drill Press.md': 'docs/users/Equipment/Danger Room/Drill Press.md'
+           'docs/users/Equipment/ShopBot.md': 'docs/users/Equipment/Danger Room/ShopBot.md'
+           'docs/users/Equipment/Big Boi Laser Cutter.md': 'docs/users/Equipment/Laser Cutting/Big Boi Laser Cutter.md'
+           'docs/users/Equipment/First Child Laser Cutter.md': 'docs/users/Equipment/Laser Cutting/First Child Laser Cutter.md'
+           'docs/users/Equipment/New Kid Laser Cutter.md': 'docs/users/Equipment/Laser Cutting/New Kid Laser Cutter.md'
+           'docs/users/Equipment/Large Format Printer.md': 'docs/users/Equipment/Print and Office/Large Format Printer.md'
+           'docs/users/Equipment/Multi-Function Printer.md': 'docs/users/Equipment/Print and Office/Multi-Function Printer.md'
+           'docs/users/Equipment/P-Touch Label Maker.md': 'docs/users/Equipment/Print and Office/P-Touch Label Maker.md'
+           'docs/users/Equipment/Retina Engrave.md': 'docs/users/Software/Retina Engrave.md'
+           'docs/users/SYN Shop v1.0.md': 'docs/users/About SYN Shop/SYN Shop 1.0.md'
+           'docs/users/SYN Shop 3.0/FAQ.md': 'docs/users/About SYN Shop/SYN Shop 3.0/FAQ.md'
+           'docs/users/SYN Shop 3.0/index.md': 'docs/users/About SYN Shop/SYN Shop 3.0/index.md'
+           'docs/users/SYN Shop Vision.md': 'docs/users/About SYN Shop/SYN Shop Vision.md'
+           'docs/users/SYNShop3.0/FAQ.md': 'docs/users/SYN Shop 3.0/FAQ.md'
+           'docs/users/SYNShop3.0/index.md': 'docs/users/SYN Shop 3.0/index.md'
+           'docs/users/media.md': 'docs/users/Shop Network.md'