From aaab18a18bd3f84c853170f32091bc026847dabf Mon Sep 17 00:00:00 2001 From: skullY Date: Mon, 7 May 2018 21:02:24 -0700 Subject: [PATCH] wip --- .../Vagrant.md} | 0 .../index.md} | 2 +- docs/05_Features/index.md | 4 +- docs/config.json | 9 +- .../Building_Your_First_Firmware.html | 17 +-- .../Complete_Newbie's_Guide.html | 17 +-- .../Flashing_Firmware.html | 17 +-- .../Testing_and_Debugging.html | 17 +-- static/Complete_Newbs_Guide/index.html | 17 +-- static/FAQ/Build_Compile_QMK.html | 17 +-- static/FAQ/Debugging_and_Troubleshooting.html | 17 +-- static/FAQ/General_FAQ.html | 17 +-- static/FAQ/Keymaps.html | 17 +-- static/FAQ/index.html | 17 +-- static/Features/Advanced_Keycodes.html | 17 +-- static/Features/Audio.html | 17 +-- static/Features/Auto_Shift.html | 17 +-- static/Features/Backlight.html | 17 +-- static/Features/Bluetooth.html | 17 +-- static/Features/Bootmagic.html | 17 +-- static/Features/Command.html | 17 +-- static/Features/Dynamic_Macros.html | 17 +-- static/Features/Grave_Escape.html | 17 +-- static/Features/Key_Lock.html | 17 +-- static/Features/Layouts.html | 17 +-- static/Features/Leader_Key.html | 17 +-- static/Features/Macros.html | 17 +-- static/Features/Mouse_Keys.html | 17 +-- static/Features/PS_2_Mouse.html | 17 +-- static/Features/Pointing_Device.html | 17 +-- static/Features/RGB_Lighting.html | 17 +-- static/Features/Space_Cadet_Shift.html | 17 +-- static/Features/Space_Cadet_Shift_Enter.html | 17 +-- static/Features/Stenography.html | 17 +-- static/Features/Swap_Hands.html | 17 +-- static/Features/Tap_Dance.html | 17 +-- static/Features/Terminal.html | 17 +-- static/Features/Thermal_Printer.html | 17 +-- static/Features/Unicode.html | 17 +-- static/Features/Userspace.html | 17 +-- static/Features/index.html | 23 +-- .../Hand_Wiring_Guide.html | 17 +-- .../ISP_Flashing_Guide.html | 17 +-- static/For_Makers_And_Modders/index.html | 17 +-- .../How_Keyboards_Work.html | 17 +-- .../Understanding_QMK.html | 17 +-- static/For_a_Deeper_Understanding/index.html | 17 +-- .../Build_Compile_Instructions.html | 19 +-- static/Getting_Started/Contributing.html | 17 +-- static/Getting_Started/Flashing_Firmware.html | 17 +-- static/Getting_Started/Getting_Help.html | 17 +-- static/Getting_Started/How_to_Use_GitHub.html | 17 +-- .../Install_Build_Tools/Vagrant.html | 132 ++++++++++++++++++ .../index.html} | 33 ++--- static/Getting_Started/Vagrant.html | 131 ----------------- static/Getting_Started/index.html | 19 +-- static/Hardware/AVR_Processors.html | 17 +-- static/Hardware/Drivers.html | 17 +-- static/Hardware/index.html | 17 +-- static/IDEs/Eclipse.html | 17 +-- static/IDEs/index.html | 17 +-- static/Keycodes/Advanced_Keycodes.html | 17 +-- static/Keycodes/Backlight.html | 17 +-- static/Keycodes/Basic.html | 17 +-- static/Keycodes/Bluetooth.html | 17 +-- static/Keycodes/Bootmagic.html | 17 +-- static/Keycodes/Quantum_Keycodes.html | 17 +-- static/Keycodes/RGB_Lighting.html | 17 +-- static/Keycodes/Stenography.html | 17 +-- static/Keycodes/Thermal_Printer.html | 17 +-- static/Keycodes/US_ANSI_Shifted_keys.html | 17 +-- static/Keycodes/index.html | 17 +-- .../Compatable_Microcontrollers.html | 17 +-- static/Reference/Config_Options.html | 17 +-- static/Reference/Custom_Code.html | 17 +-- .../Documentation_Best_Practices.html | 17 +-- static/Reference/Documentation_Templates.html | 17 +-- static/Reference/Glossary.html | 17 +-- static/Reference/Keyboard_Guidelines.html | 17 +-- static/Reference/Keymap_Overview.html | 17 +-- static/Reference/Unit_Testing.html | 17 +-- static/Reference/index.html | 17 +-- static/index.html | 19 +-- static/tipuesearch/tipuesearch_content.json | 2 +- 84 files changed, 847 insertions(+), 770 deletions(-) rename docs/01_Getting_Started/{02_Vagrant.md => 01_Install_Build_Tools/Vagrant.md} (100%) rename docs/01_Getting_Started/{01_Install_Build_Tools.md => 01_Install_Build_Tools/index.md} (99%) create mode 100644 static/Getting_Started/Install_Build_Tools/Vagrant.html rename static/Getting_Started/{Install_Build_Tools.html => Install_Build_Tools/index.html} (60%) delete mode 100644 static/Getting_Started/Vagrant.html diff --git a/docs/01_Getting_Started/02_Vagrant.md b/docs/01_Getting_Started/01_Install_Build_Tools/Vagrant.md similarity index 100% rename from docs/01_Getting_Started/02_Vagrant.md rename to docs/01_Getting_Started/01_Install_Build_Tools/Vagrant.md diff --git a/docs/01_Getting_Started/01_Install_Build_Tools.md b/docs/01_Getting_Started/01_Install_Build_Tools/index.md similarity index 99% rename from docs/01_Getting_Started/01_Install_Build_Tools.md rename to docs/01_Getting_Started/01_Install_Build_Tools/index.md index 09a80ea15..530b777a0 100644 --- a/docs/01_Getting_Started/01_Install_Build_Tools.md +++ b/docs/01_Getting_Started/01_Install_Build_Tools/index.md @@ -139,4 +139,4 @@ docker run -e keymap=default -e keyboard=ergodox_ez --rm -v D:/Users/Sacapuces/D This will compile the targeted keyboard/keymap and leave it in your QMK directory for you to flash. ## Vagrant -If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [vagrant guide](01_Getting_Started/02_Vagrant.md). +If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [vagrant guide](01_Getting_Started/01_Install_Build_Tools/Vagrant.md). diff --git a/docs/05_Features/index.md b/docs/05_Features/index.md index aa1c30ec4..92e148085 100644 --- a/docs/05_Features/index.md +++ b/docs/05_Features/index.md @@ -3,9 +3,9 @@ QMK has a staggering number of features for building your keyboard. It can take some time to understand all of them and determine which one will achieve your goal. -* [Advanced Keycodes](Advanced Keycodes.md) - Change layers, type shifted keys, and more. Go beyond typing simple characters. +* [Advanced Keycodes](Advanced_Keycodes.md) - Change layers, type shifted keys, and more. Go beyond typing simple characters. * [Audio](Audio.md) - Connect a speaker to your keyboard for audio feedback, midi support, and music mode. -* [Auto Shift](Auto Shift.md) - Tap for the normal key, hold slightly longer for its shifted state. +* [Auto Shift](Auto_Shift.md) - Tap for the normal key, hold slightly longer for its shifted state. * [Backlight](Backlight.md) - LED lighting support for your keyboard. * [Bootmagic](Bootmagic.md) - Adjust the behavior of your keyboard using hotkeys. * [Dynamic Macros](Dynamic_Macros.md) - Record and playback macros from the keyboard itself. diff --git a/docs/config.json b/docs/config.json index 485ee040f..0660d070e 100644 --- a/docs/config.json +++ b/docs/config.json @@ -22,13 +22,10 @@ "auto_toc": true, "breadcrumbs": true, "breadcrumbs_separator": " &emdash;> ", - "buttons": { - "QMK Website": "https://qmk.fm/" - }, - "links": { - "QMK Link": "https://qmk.fm/" - }, + "edit_on_github": "qmk/qmk_firmware/blob/master/docs", "repo": "qmk/qmk_firmware", + "search": true, + "theme": "daux-navy", "toggle_code": false } } diff --git a/static/Complete_Newbs_Guide/Building_Your_First_Firmware.html b/static/Complete_Newbs_Guide/Building_Your_First_Firmware.html index 570fb2344..d498eea91 100644 --- a/static/Complete_Newbs_Guide/Building_Your_First_Firmware.html +++ b/static/Complete_Newbs_Guide/Building_Your_First_Firmware.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@ - + @@ -45,13 +45,10 @@
- +
-
- QMK Link -
-
+
@@ -64,7 +61,11 @@

Complete Newbs Guide Building Your First Firmware

-
+ + + Edit on GitHub + +
diff --git a/static/Getting_Started/Contributing.html b/static/Getting_Started/Contributing.html index b52cc7f4c..f900907d6 100644 --- a/static/Getting_Started/Contributing.html +++ b/static/Getting_Started/Contributing.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@ - + @@ -45,13 +45,10 @@
- +
-
- QMK Link -
-
+
@@ -64,7 +61,11 @@

Getting Started Contributing

-
+ + + Edit on GitHub + +