Disable the landing page
This commit is contained in:
parent
d5a84addd3
commit
8184b96523
@ -1,25 +0,0 @@
|
|||||||
# Quantum Mechanical Keyboard Firmware
|
|
||||||
|
|
||||||
## What is QMK Firmware?
|
|
||||||
|
|
||||||
QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.
|
|
||||||
|
|
||||||
## How to Get It
|
|
||||||
|
|
||||||
If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is [fork the repo through Github](https://github.com/qmk/qmk_firmware#fork-destination-box), and clone your repo locally to make your changes, push them, then open a [Pull Request](https://github.com/qmk/qmk_firmware/pulls) from your fork.
|
|
||||||
|
|
||||||
Otherwise, you can either download it directly ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), or clone it via git (`git@github.com:qmk/qmk_firmware.git`), or https (`https://github.com/qmk/qmk_firmware.git`).
|
|
||||||
|
|
||||||
## How to Compile
|
|
||||||
|
|
||||||
Before you are able to compile, you'll need to [install an environment](01_Getting_Started/01_Install_Build_Tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation:
|
|
||||||
|
|
||||||
make planck/rev4:default
|
|
||||||
|
|
||||||
This would build the `rev4` revision of the `planck` with the `default` keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted:
|
|
||||||
|
|
||||||
make preonic:default
|
|
||||||
|
|
||||||
## How to Customize
|
|
||||||
|
|
||||||
QMK has lots of [features](05_Features/index.md) to explore, and a good deal of [reference documentation](http://docs.qmk.fm) to dig through. Most features are taken advantage of by modifying your [keymap](07_Reference/Keymap_Overview.md), and changing the [keycodes](06_Keycodes/index.md).
|
|
@ -18,6 +18,7 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"html": {
|
"html": {
|
||||||
|
"auto_landing": false,
|
||||||
"auto_toc": true,
|
"auto_toc": true,
|
||||||
"breadcrumbs": true,
|
"breadcrumbs": true,
|
||||||
"breadcrumbs_separator": " &emdash;> ",
|
"breadcrumbs_separator": " &emdash;> ",
|
||||||
|
89
docs/foo
Executable file
89
docs/foo
Executable file
@ -0,0 +1,89 @@
|
|||||||
|
sed -i .bak \
|
||||||
|
-e s,Getting_Started,01_Getting_Started,g \
|
||||||
|
-e s,Complete_Newbs_Guide,02_Complete_Newbs_Guide,g \
|
||||||
|
-e s,FAQ,03_FAQ,g \
|
||||||
|
-e s,Hardware,04_Hardware,g \
|
||||||
|
-e s,Features,05_Features,g \
|
||||||
|
-e s,Keycodes,06_Keycodes,g \
|
||||||
|
-e s,Reference,07_Reference,g \
|
||||||
|
-e s,For_Makers_And_Modders,08_For_Makers_And_Modders,g \
|
||||||
|
-e s,IDEs,09_IDEs,g \
|
||||||
|
$1
|
||||||
|
|
||||||
|
exit 0
|
||||||
|
sed -i .bak \
|
||||||
|
-e s,newbs.md,Complete_Newbs_Guide/00_Complete_Newbie\'s_Guide.md,g \
|
||||||
|
-e s,newbs_building_firmware.md,Complete_Newbs_Guide/02_Building_Your_First_Firmware.md,g \
|
||||||
|
-e s,newbs_flashing.md,Complete_Newbs_Guide/03_Flashing_Firmware.md,g \
|
||||||
|
-e s,newbs_testing_debugging.md,Complete_Newbs_Guide/04_Testing_and_Debugging.md,g \
|
||||||
|
-e s,newbs_getting_started.md,Complete_Newbs_Guide/index.md,g \
|
||||||
|
-e s,faq_general.md,FAQ/02_General_FAQ.md,g \
|
||||||
|
-e s,faq_build.md,FAQ/03_Build_Compile_QMK.md,g \
|
||||||
|
-e s,faq_debug.md,FAQ/04_Debugging_and_Troubleshooting.md,g \
|
||||||
|
-e s,faq_keymap.md,FAQ/05_Keymaps.md,g \
|
||||||
|
-e s,faq.md,FAQ/index.md,g \
|
||||||
|
-e s,feature_advanced_keycodes.md,Features/Advanced_Keycodes.md,g \
|
||||||
|
-e s,feature_audio.md,Features/Audio.md,g \
|
||||||
|
-e s,feature_auto_shift.md,Features/Auto_Shift.md,g \
|
||||||
|
-e s,feature_backlight.md,Features/Backlight.md,g \
|
||||||
|
-e s,feature_bluetooth.md,Features/Bluetooth.md,g \
|
||||||
|
-e s,feature_bootmagic.md,Features/Bootmagic.md,g \
|
||||||
|
-e s,feature_command.md,Features/Command.md,g \
|
||||||
|
-e s,feature_dynamic_macros.md,Features/Dynamic_Macros.md,g \
|
||||||
|
-e s,feature_grave_esc.md,Features/Grave_Escape.md,g \
|
||||||
|
-e s,feature_key_lock.md,Features/Key_Lock.md,g \
|
||||||
|
-e s,feature_layouts.md,Features/Layouts.md,g \
|
||||||
|
-e s,feature_leader_key.md,Features/Leader_Key.md,g \
|
||||||
|
-e s,feature_macros.md,Features/Macros.md,g \
|
||||||
|
-e s,feature_mouse_keys.md,Features/Mouse_Keys.md,g \
|
||||||
|
-e s,feature_ps2_mouse.md,Features/PS_2_Mouse.md,g \
|
||||||
|
-e s,feature_pointing_device.md,Features/Pointing_Device.md,g \
|
||||||
|
-e s,feature_rgblight.md,Features/RGB_Lighting.md,g \
|
||||||
|
-e s,feature_space_cadet.md,Features/Space_Cadet_Shift.md,g \
|
||||||
|
-e s,feature_space_shift_cadet.md,Features/Space_Cadet_Shift_Enter.md,g \
|
||||||
|
-e s,feature_stenography.md,Features/Stenography.md,g \
|
||||||
|
-e s,feature_swap_hands.md,Features/Swap_Hands.md,g \
|
||||||
|
-e s,feature_tap_dance.md,Features/Tap_Dance.md,g \
|
||||||
|
-e s,feature_terminal.md,Features/Terminal.md,g \
|
||||||
|
-e s,feature_thermal_printer.md,Features/Thermal_Printer.md,g \
|
||||||
|
-e s,feature_unicode.md,Features/Unicode.md,g \
|
||||||
|
-e s,feature_userspace.md,Features/Userspace.md,g \
|
||||||
|
-e s,features.md,Features/index.html,g \
|
||||||
|
-e s,hand_wire.md,For_Makers_And_Modders/Hand_Wiring_Guide.md,g \
|
||||||
|
-e s,isp_flashing_guide.md,For_Makers_And_Modders/ISP_Flashing_Guide.md,g \
|
||||||
|
-e s,how_keyboards_work.md,For_a_Deeper_Understanding/How_Keyboards_Work.md,g \
|
||||||
|
-e s,understanding_qmk.md,For_a_Deeper_Understanding/Understanding_QMK.md,g \
|
||||||
|
-e s,getting_started_vagrant.md,Getting_Started/02_Vagrant.md,g \
|
||||||
|
-e s,getting_started_make_guide.md,Getting_Started/03_Build_Compile_Instructions.md,g \
|
||||||
|
-e s,flashing.md,Getting_Started/04_Flashing_Firmware.md,g \
|
||||||
|
-e s,contributing.md,Getting_Started/05_Contributing.md,g \
|
||||||
|
-e s,getting_started_github.md,Getting_Started/06_How_to_Use_GitHub.md,g \
|
||||||
|
-e s,getting_started_getting_help.md,Getting_Started/07_Getting_Help.md,g \
|
||||||
|
-e s,getting_started_introduction.md,Getting_Started/index.html,g \
|
||||||
|
-e s,getting_started_build_tools.md,Getting_Started/index.md,g \
|
||||||
|
-e s,hardware_avr.md,Hardware/02_AVR_Processors.md,g \
|
||||||
|
-e s,hardware_drivers.md,Hardware/04_Drivers.md,g \
|
||||||
|
-e s,hardware.md,Hardware/index.md,g \
|
||||||
|
-e s,eclipse.md,IDEs/Eclipse.md,g \
|
||||||
|
-e s,internals_defines.md,Internals/internals_defines.md,g \
|
||||||
|
-e s,internals_input_callback_reg.md,Internals/internals_input_callback_reg.md,g \
|
||||||
|
-e s,internals_midi_device.md,Internals/internals_midi_device.md,g \
|
||||||
|
-e s,internals_midi_device_setup_process.md,Internals/internals_midi_device_setup_process.md,g \
|
||||||
|
-e s,internals_midi_util.md,Internals/internals_midi_util.md,g \
|
||||||
|
-e s,internals_send_functions.md,Internals/internals_send_functions.md,g \
|
||||||
|
-e s,internals_sysex_tools.md,Internals/internals_sysex_tools.md,g \
|
||||||
|
-e s,keycodes_basic.md,Keycodes/Basic.md,g \
|
||||||
|
-e s,quantum_keycodes.md,Keycodes/Quantum_Keycodes.md,g \
|
||||||
|
-e s,keycodes_us_ansi_shifted.md,Keycodes/US_ANSI_Shifted_keys.md,g \
|
||||||
|
-e s,keycodes.md,Keycodes/index.md,g \
|
||||||
|
-e s,hardware_keyboard_guidelines.md,Reference/01_Keyboard_Guidelines.md,g \
|
||||||
|
-e s,compatible_microcontrollers.md,Reference/Compatable_Microcontrollers.md,g \
|
||||||
|
-e s,config_options.md,Reference/Config_Options.md,g \
|
||||||
|
-e s,custom_quantum_functions.md,Reference/Custom_Code.md,g \
|
||||||
|
-e s,documentation_best_practices.md,Reference/Documentation_Best_Practices.md,g \
|
||||||
|
-e s,documentation_templates.md,Reference/Documentation_Templates.md,g \
|
||||||
|
-e s,reference_glossary.md,Reference/Glossary.md,g \
|
||||||
|
-e s,keymap.md,Reference/Keymap_Overview.md,g \
|
||||||
|
-e s,unit_testing.md,Reference/Unit_Testing.md,g \
|
||||||
|
-e s,README.md,index.md,g \
|
||||||
|
$1
|
@ -4,6 +4,22 @@
|
|||||||
|
|
||||||
QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.
|
QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.
|
||||||
|
|
||||||
## How to Get Started
|
## How to Get It
|
||||||
|
|
||||||
Dive into the [documentation](README.md)!
|
If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is [fork the repo through Github](https://github.com/qmk/qmk_firmware#fork-destination-box), and clone your repo locally to make your changes, push them, then open a [Pull Request](https://github.com/qmk/qmk_firmware/pulls) from your fork.
|
||||||
|
|
||||||
|
Otherwise, you can either download it directly ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), or clone it via git (`git@github.com:qmk/qmk_firmware.git`), or https (`https://github.com/qmk/qmk_firmware.git`).
|
||||||
|
|
||||||
|
## How to Compile
|
||||||
|
|
||||||
|
Before you are able to compile, you'll need to [install an environment](01_Getting_Started/01_Install_Build_Tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation:
|
||||||
|
|
||||||
|
make planck/rev4:default
|
||||||
|
|
||||||
|
This would build the `rev4` revision of the `planck` with the `default` keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted:
|
||||||
|
|
||||||
|
make preonic:default
|
||||||
|
|
||||||
|
## How to Customize
|
||||||
|
|
||||||
|
QMK has lots of [features](05_Features/index.md) to explore, and a good deal of [reference documentation](http://docs.qmk.fm) to dig through. Most features are taken advantage of by modifying your [keymap](07_Reference/Keymap_Overview.md), and changing the [keycodes](06_Keycodes/index.md).
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user