Merge pull request #16 from HumbleDeer/gh-pages

Formatting, markdown fixes, gitignore updated for local deploy
ZeroGDesign · Sep 19, 2023 · 894bc74 · 894bc74
2 parents d87d2a8 + a8f90fd
commit 894bc74
Show file tree

Hide file tree

Showing 34 changed files with 358 additions and 348 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-.vscode/settings.json
+# Executable files
 docs/assets/images/instructions/trim_dragged_image_new.exe
 docs/assets/images/instructions/hydra/left_arm/trim_dragged_image_new.exe
 docs/assets/images/instructions/hydra/right_arm/horizontal_flip_images.exe
@@ -7,5 +7,22 @@ docs/assets/images/examples/trim_dragged_image_new.exe
 docs/assets/images/instructions/m1_1/left_stepper_tower/trim_dragged_image_new.exe
 docs/assets/images/instructions/m1_1/right_stepper_tower/trim_dragged_image_new.exe
 docs/assets/images/instructions/m1_1/left_front_tower/trim_dragged_image_new.exe
-docs/Gemfile.lock
+
+# Jekyll build output
+_site/
+.sass-cache
+.jekyll-metadata
+
+# Bundler / Ruby / Jekyll
+.bundle/config
+vendor/bundle/
+
+# User VSCode files
+.vscode/
+
+# Repo specific
+CNAME
 .gitignore
+
+# MacOS metadata file
+**/.DS_Store 
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/README.md b/docs/README.md
@@ -2,16 +2,34 @@
 
 While we're happy to have you here, we want to let you know that you won't find our full range of ZeroG project content here. Instead, we invite you to check out our official website at [https://docs.zerog.one/](https://docs.zerog.one/), where you can explore everything related to our 3D printing projects and other ZeroG initiatives. There, you'll find a wealth of information and resources related to our work, from our latest 3D models to our ambitious plans for space exploration. So don't miss out - head on over to our website and join us on our mission!
 
-# Discord
+## Discord
 
 If you haven't already joined our Discord at [https://discord.gg/zerog](https://discord.gg/zerog), you're missing out on some serious fun! Our Discord server is the perfect place to connect with other makers, share your latest 3D printing projects, and swap some space-themed puns.
 
-# License
+[![Join us on Discord](https://discordapp.com/api/guilds/747612067951018075/widget.png?style=banner2)](https://discord.gg/zerog)
+
+## Contributing
+
+Contributing to the ZeroG docs is easy. To get started, create a fork of this repo. Next, clone the forked repo to your local machine or open it up in the GitHub UI. Make changes to the files you'd like to edit, commit them, and make a pull request [over here](https://github.com/ZeroGDesign/docs/pulls).
+
+### Local build testing
+
+The ZeroG docs are built with Jekyll. In order to build a local version for testing, you'll need to install Ruby and Bundler.  
+Then:
+
+1. Navigate to the `docs/` subfolder of the repository
+2. Open a terminal
+3. Run `bundler install`
+4. Run `bundler exec jekyll build` or `bundler exec jekyll serve`
+
+## License
 
 We would like to inform you that our platform uses the "Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)" license to protect our community and files. This license is a popular choice in the creative industry and allows others to share, adapt, and build upon our work while ensuring that our intellectual property rights are respected.
 
 Under this license, users are free to use our work as long as they provide appropriate credit, do not use it for commercial purposes, and share any derivative works under the same license. By using this license, we aim to promote collaboration and innovation within our community while safeguarding our content.
 
-For more information on the "Attribution-NonCommercial-ShareAlike 4.0 International" license and how it works, please [click here](https://creativecommons.org/licenses/by-nc-sa/4.0/) to read more.
-
 Thank you for choosing our platform, and we look forward to working with you.
+
+![Attribution-NonCommercial-ShareAlike 4.0](https://upload.wikimedia.org/wikipedia/commons/thumb/1/12/Cc-by-nc-sa_icon.svg/120px-Cc-by-nc-sa_icon.svg.png)
+
+More info: [https://creativecommons.org/licenses/by-nc-sa/4.0/](https://creativecommons.org/licenses/by-nc-sa/4.0/)
diff --git a/docs/_includes/footer_custom.html b/docs/_includes/footer_custom.html
@@ -1,4 +1,5 @@
 <p class="text-small text-grey-dk-000 mb-0">
     Copyright (c) {{ site.time | date: '%Y' }}, ZeroG. All rights reserved.
-<a class="floatingtop" href="#top"></a><br>
-<span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">ZeroG</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://zerog.one/" property="cc:attributionName" rel="cc:attributionURL">https://zerog.one/</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0 International License</a>.</p>
+    <a class="floatingtop" href="#top"></a><br/>
+    <span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">ZeroG</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://zerog.one/" property="cc:attributionName" rel="cc:attributionURL">https://zerog.one/</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0 International License</a>.
+</p>
diff --git a/docs/database/bom.json b/docs/database/bom.json
@@ -586,7 +586,7 @@
             "identifier": "merc_light",
             "type": {
                 "description": "Lightweight Extrusion",
-                "note": "Compatible with (5/pro) - 370mm, only works with the rail on top.<br>You need a <b>330mm MGN12H rail!</b>"
+                "note": "Compatible with (5/pro) - 370mm, only works with the rail on top.<br/>You need a <b>330mm MGN12H rail!</b>"
             },
             "source": [
                 {
@@ -683,7 +683,7 @@
             "identifier": "MGN12mm",
             "type": {
                 "description": "Linear Rail",
-                "note": "Ender 5/Pro 300mm (330mm max)<br>Ender 5 Plus 450mm"
+                "note": "Ender 5/Pro 300mm (330mm max)<br/>Ender 5 Plus 450mm"
             },
             "source": [
                 {
@@ -708,7 +708,7 @@
             "identifier": "TR8_Leadscrew",
             "type": {
                 "description": "Lead Screw",
-                "note": "You want 2mm lead<br>8mm lead is untested"
+                "note": "You want 2mm lead<br/>8mm lead is untested"
             },
             "source": [
                 {
@@ -803,19 +803,19 @@
             "source": [
                 {
                     "region": "US",
-                    "name": "Fabreeko<br>(275/377mm heater)",
+                    "name": "Fabreeko<br/>(275/377mm heater)",
                     "url": "https://www.fabreeko.com/collections/zero-g/products/fabreeko-edge-to-edge-heaters-for-zero-g",
                     "verified": true
                 },
                 {
                     "region": "CN",
-                    "name": "Fysetc<br>(Heater, 255x255x8mm bed, surface, magnet)",
+                    "name": "Fysetc<br/>(Heater, 255x255x8mm bed, surface, magnet)",
                     "url": "https://s.click.aliexpress.com/e/_DnKgYY3",
                     "verified": true
                 },
                 {
                     "region": "CN",
-                    "name": "Fysetc<br>(Heater, 377x370x8mm bed, surface, magnet)",
+                    "name": "Fysetc<br/>(Heater, 377x370x8mm bed, surface, magnet)",
                     "url": "https://s.click.aliexpress.com/e/_Deflc7X",
                     "verified": true
                 }
@@ -831,25 +831,25 @@
             "source": [
                 {
                     "region": "US",
-                    "name": "Fabreeko<br>(275x275x8mm/ 377x370x8mm bed)",
+                    "name": "Fabreeko<br/>(275x275x8mm/ 377x370x8mm bed)",
                     "url": "https://www.fabreeko.com/products/zero-g-atp5-aluminum-beds-for-ender-5-pro-plus-hydra-conversion",
                     "verified": true
                 },
                 {
                     "region": "EU",
-                    "name": "Kris3D<br>(254x254x8mm/ 377x370x8mm bed)",
+                    "name": "Kris3D<br/>(254x254x8mm/ 377x370x8mm bed)",
                     "url": "https://www.kris3d.de/products/zerog-hydra",
                     "verified": true
                 },
                 {
                     "region": "CN",
-                    "name": "Fysetc<br>(Heater, 255x255x8mm bed, surface, magnet)",
+                    "name": "Fysetc<br/>(Heater, 255x255x8mm bed, surface, magnet)",
                     "url": "https://s.click.aliexpress.com/e/_DnKgYY3",
                     "verified": true
                 },
                 {
                     "region": "CN",
-                    "name": "Fysetc<br>(Heater, 377x370x8mm bed, surface, magnet)",
+                    "name": "Fysetc<br/>(Heater, 377x370x8mm bed, surface, magnet)",
                     "url": "https://s.click.aliexpress.com/e/_Deflc7X",
                     "verified": true
                 }
@@ -1130,7 +1130,7 @@
             "identifier": "gates_belts_6mm",
             "type": {
                 "description": "6MM-2GT",
-                "note": "Ender 5(PRO) 5 Meter<br>Ender 5 Plus 6 meter."
+                "note": "Ender 5(PRO) 5 Meter<br/>Ender 5 Plus 6 meter."
             },
             "source": [
                 {
@@ -1240,13 +1240,13 @@
                 },
                 {
                     "region": "CN",
-                    "name": "Fysetc<br>(Heater, 255x255x8mm bed, surface, magnet)",
+                    "name": "Fysetc<br/>(Heater, 255x255x8mm bed, surface, magnet)",
                     "url": "https://s.click.aliexpress.com/e/_DnKgYY3",
                     "verified": true
                 },
                 {
                     "region": "CN",
-                    "name": "Fysetc<br>(Heater, 377x370x8mm bed, surface, magnet)",
+                    "name": "Fysetc<br/>(Heater, 377x370x8mm bed, surface, magnet)",
                     "url": "https://s.click.aliexpress.com/e/_Deflc7X",
                     "verified": true
                 }

diff --git a/docs/pages/klipper/klipper_calculator.md b/docs/pages/klipper/klipper_calculator.md
@@ -28,11 +28,11 @@ The value you use as input should be the **RMS** value. **Not** the peak value t
 #### run_current
 {: .no_toc }
 <form>
-    Motor peak current<br><input type="text" class="textfield_dark" id="peak_current" Value="1.4"/><br>
+    Motor peak current<br/><input type="text" class="textfield_dark" id="peak_current" Value="1.4"/><br/>
 
-    Max recommended current: 80%<br>
+    Max recommended current: 80%<br/>
 
-    <input type="button" class="btn" onClick="calculate_runcurrent()" Value="Calculate" /><br>
+    <input type="button" class="btn" onClick="calculate_runcurrent()" Value="Calculate" /><br/>
 
     Your run_current: <b><span id = "result_runcurrent">0.79</span></b>
 
@@ -74,19 +74,19 @@ On an extruder, the rotation_distance is the amount of distance the filament tra
 
 <div class="code-example" markdown="1">
 <form>
-    Use a marker to place a mark on the filament around 120mm from the intake of the extruder body. Then use a digital calipers to measure the actual distance of that mark as precisely as one can.<br><br>
+    Use a marker to place a mark on the filament around 120mm from the intake of the extruder body. Then use a digital calipers to measure the actual distance of that mark as precisely as one can.<br/><br/>
 
-    Measure initial mark distance in mm<br><input type="text" class="textfield_dark" id="initial_mark_distance" Value="120"/><br>
-<br>
-    Use the digital calipers to measure the new distance between the extruder body and the mark on the filament <b>after you've extruded 100mm of filament.</b><br><br>
+    Measure initial mark distance in mm<br/><input type="text" class="textfield_dark" id="initial_mark_distance" Value="120"/><br/>
+<br/>
+    Use the digital calipers to measure the new distance between the extruder body and the mark on the filament <b>after you've extruded 100mm of filament.</b><br/><br/>
 
-    New distance in mm<br><input type="text" class="textfield_dark" id="subsequent_mark_distance" Value="20"/><br>
-<br>
+    New distance in mm<br/><input type="text" class="textfield_dark" id="subsequent_mark_distance" Value="20"/><br/>
+<br/>
 
-    We're, now going to calculate your new rotation_distance, please provide your previous rotation_distance below.<br><br>
+    We're, now going to calculate your new rotation_distance, please provide your previous rotation_distance below.<br/><br/>
 
-    Previous rotation distance<br><input type="text" class="textfield_dark" id="previous_rotation_distance" Value="0"/><br><br>
-    <input type="button" class="btn" onClick="calculate_rotation_distance()" Value="Calculate" /><br>
+    Previous rotation distance<br/><input type="text" class="textfield_dark" id="previous_rotation_distance" Value="0"/><br/><br/>
+    <input type="button" class="btn" onClick="calculate_rotation_distance()" Value="Calculate" /><br/>
 
     New rotation_distance: <span id = "result_rotation_distance">0.000</span>
 

diff --git a/docs/pages/klipper/klipper_macrogenerator.md b/docs/pages/klipper/klipper_macrogenerator.md
@@ -96,10 +96,10 @@ Level the bed*
 <hr>
 
 <h4>Before you generate!</h4>
-Make sure the options that you've selected are correct and fit your machine. If you do not know, join our <a href="https://discord.gg/zerog" target="_blank"><i class="bi bi-discord"></i> Discord</a>. and ask for help.<br><br>
+Make sure the options that you've selected are correct and fit your machine. If you do not know, join our <a href="https://discord.gg/zerog" target="_blank"><i class="bi bi-discord"></i> Discord</a>. and ask for help.<br/><br/>
 
 <button class="btn" type="button" onclick="generateMacro(); parent.location='#gcode_box_arcs'">Generate</button>
-<br>
+<br/>
 </form>
 </div>
 
@@ -111,7 +111,7 @@ Make sure the options that you've selected are correct and fit your machine. If
         <div class="infobar">Did you enable Klipper ARCs?</div>
             <div class="language-lua highlighter-rouge">
                 <div class="highlight">
-                    <pre class="highlight"># Enable arcs support<br>[gcode_arcs]<br>resolution: 0.1</pre>
+                    <pre class="highlight"># Enable arcs support<br/>[gcode_arcs]<br/>resolution: 0.1</pre>
                 </div>
             </div>
         <div class="infobar"><button class="btn" onClick="parent.location='#gcode_box'" type="button">Yes <i class="bi bi-check-lg"></i></button> <button class="btn" onClick="parent.location='#gcode_box_arcs_sh'" type="button">No <i class="bi bi-x-lg"></i></button></div>

diff --git a/docs/pages/manual/build/Electronics_enclosure/introduction.md b/docs/pages/manual/build/Electronics_enclosure/introduction.md
@@ -11,13 +11,12 @@ permalink: /manual/build/electronics_enclosure/introduction
 # 1. Introduction
 {: .no_toc }
 
-
 Building the Electronics enclosure
 {: .fs-6 .fw-300 }
 
 <dl>
   <dt>Difficulty</dt>
-  <dd><font COLOR="#FF3001">Advance</font></dd>
+  <dd><span style="color:#FF3001">Advanced</span></dd>
   <dt>Language</dt>
   <dd>English</dd>
 </dl>
@@ -29,8 +28,8 @@ Hovering an image with your mouse will show a zoom icon <i class="bi bi-zoom-in"
 ## Tools required
 
 | :-------------------------: | :--------------------       | -------------------------------------------------------------------------------: |
-| Tool<br>Description| Soldering iron<br>Used for heat set inserts |     [![soldering iron](../../../../assets/images/tools/soldering_iron.png)](#lightbox__item_1){: .lightbox_wrapper} |
-| Tool<br>Description<br>Sizes| Hex Keys<br>Used to tighten and losen bolts<br>2mm, 2.5mm, 3mm|     [![soldering iron](../../../../assets/images/tools/wera_hexkeys.png)](#lightbox__item_2){: .lightbox_wrapper} |
+| Tool<br/>Description| Soldering iron<br/>Used for heat set inserts |     [![soldering iron](../../../../assets/images/tools/soldering_iron.png)](#lightbox__item_1){: .lightbox_wrapper} |
+| Tool<br/>Description<br/>Sizes| Hex Keys<br/>Used to tighten and losen bolts<br/>2mm, 2.5mm, 3mm|     [![soldering iron](../../../../assets/images/tools/wera_hexkeys.png)](#lightbox__item_2){: .lightbox_wrapper} |
 {: class="hardwaretable"}
 
 <div onclick="location.href='##';"  id="lightbox__item_1"  class="lightbox__item">
@@ -65,10 +64,7 @@ Hovering an image with your mouse will show a zoom icon <i class="bi bi-zoom-in"
 
 ## Need more help?
 
-Lost? Need help? Not sure? Join our [Discord server <i class="bi bi-discord"></i>](https://discord.gg/zerog){:target="_blank"}, we've got a big community ready to help you out 
-
+Lost? Need help? Not sure? Join our [Discord server <i class="bi bi-discord"></i>](https://discord.gg/zerog){:target="_blank"}, we've got a big community ready to help you out!
 
-{: style="text-align: center" }
-<span class="fs-8">
+{: style="text-align: center" .fs-8}
 [Next step <i class="bi bi-arrow-return-right"></i>](#){: .btn .btn-red }
-</span>
diff --git a/docs/pages/manual/build/Electronics_enclosure/manual_overview.md b/docs/pages/manual/build/Electronics_enclosure/manual_overview.md
@@ -15,7 +15,5 @@ permalink: /manual/build/electronics_enclosure
 1. Table of content
 {:toc}
 
-{: style="text-align: center" }
-<span class="fs-8">
+{: style="text-align: center" .fs-8}
 [Step One &rarr;](/manual/build/hydra/introduction){: .btn .btn-red }
-</span>