diff options
| -rw-r--r-- | docs/zh-cn/README.md | 32 | ||||
| -rw-r--r-- | docs/zh/_sidebar.md | 99 |
2 files changed, 99 insertions, 32 deletions
diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md deleted file mode 100644 index bb9d1371f..000000000 --- a/docs/zh-cn/README.md +++ /dev/null | |||
| @@ -1,32 +0,0 @@ | |||
| 1 | # QMK鍵盤固件 | ||
| 2 | |||
| 3 | [](https://github.com/qmk/qmk_firmware/tags) | ||
| 4 | [](https://travis-ci.org/qmk/qmk_firmware) | ||
| 5 | [](https://discord.gg/Uq7gcHh) | ||
| 6 | [](https://docs.qmk.fm) | ||
| 7 | [](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
| 8 | [](https://github.com/qmk/qmk_firmware/) | ||
| 9 | |||
| 10 | ## 什麼是QMK固件? | ||
| 11 | |||
| 12 | QMK是一個由社群維護的開源鍵盤韌體,其中包含了QMK Toolbox、qmk.fm和其它文件。QMK韌體是以[tmk\_keyboard](http://github.com/tmk/tmk_keyboard)為基礎,讓一些有用的功能在Atmel AVR控制器實現,使用於[OLKB](https://olkb.com)、[ergodox EZ](http://www.ergodox-ez.com),和[Clueboard](http://clueboard.co/)的產品中。它也被移植到使用ChibiOS的ARM晶片上。你也可以用它來讓你徒手佈線,或是客製的鍵盤PCB發揮功能。 | ||
| 13 | |||
| 14 | ## 如何得到QMK | ||
| 15 | |||
| 16 | 如果你打算貢獻鍵盤佈局,鍵盤或功能QMK,最容易做的事情是[叉通過Github上爬行](https://github.com/qmk/qmk_firmware#fork-destination-box),和克隆你爬在本地進行更改,推動他們,然後打開從你的叉子[拉請求](https://github.com/qmk/qmk_firmware/pulls)。 | ||
| 17 | |||
| 18 | 否則,您可以直接下載([拉鍊](https://github.com/qmk/qmk_firmware/zipball/master) [焦油](https://github.com/qmk/qmk_firmware/tarball/master)),或者通過GIT中克隆它(`git@github.com:qmk/qmk_firmware.git`)或HTTP(`https://github.com/qmk/qmk_firmware.git`)。 | ||
| 19 | |||
| 20 | ## 如何編譯 | ||
| 21 | |||
| 22 | 你可以編譯之前,你需要[安裝環境](getting_started_build_tools.md)用於AVR或/和ARM開發。一旦完成,你會使用`make`命令建立一個鍵盤並用以下符號鍵盤佈局 | ||
| 23 | |||
| 24 | make planck/rev4:default | ||
| 25 | |||
| 26 | 這將建立`rev4` `planck`的修訂與`default`鍵盤映射。並非所有鍵盤有一個修訂版(也稱為子項目或文件夾),在這種情況下,它可以被省略: | ||
| 27 | |||
| 28 | make preonic:default | ||
| 29 | |||
| 30 | ## 如何赶近 | ||
| 31 | |||
| 32 | QMK有很多[特點](features.md)探索和很好的協議[參考文獻](http://docs.qmk.fm)挖通的。大部分功能通過修改[鍵盤映射(keymap.md),並改變[鍵碼](keycodes.md)冤大頭。 | ||
diff --git a/docs/zh/_sidebar.md b/docs/zh/_sidebar.md new file mode 100644 index 000000000..c16761292 --- /dev/null +++ b/docs/zh/_sidebar.md | |||
| @@ -0,0 +1,99 @@ | |||
| 1 | * [完全指南菜鳥](zh/newbs.md) | ||
| 2 | * [入門](zh/newbs_getting_started.md) | ||
| 3 | * [構建第一個固件](zh/newbs_building_firmware.md) | ||
| 4 | * [刷新固件](zh/newbs_flashing.md) | ||
| 5 | * [測試和調試](zh/newbs_testing_debugging.md) | ||
| 6 | * [最佳實踐](zh/newbs_best_practices.md) | ||
| 7 | * [學習資源](zh/newbs_learn_more_resources.md) | ||
| 8 | |||
| 9 | * [QMK基礎](zh/README.md) | ||
| 10 | * [QMK簡介](zh/getting_started_introduction.md) | ||
| 11 | * [特約QMK](zh/contributing.md) | ||
| 12 | * [如何使用Github上](zh/getting_started_github.md) | ||
| 13 | * [獲得幫助](zh/getting_started_getting_help.md) | ||
| 14 | |||
| 15 | * [常問問題](zh/faq.md) | ||
| 16 | * [常問問題](zh/faq_general.md) | ||
| 17 | * [構建/編譯QMK](zh/faq_build.md) | ||
| 18 | * [調試/故障排除QMK](zh/faq_debug.md) | ||
| 19 | * [鍵盤佈局](zh/faq_keymap.md) | ||
| 20 | |||
| 21 | * 詳細指南 | ||
| 22 | * [安裝編譯工具](zh/getting_started_build_tools.md) | ||
| 23 | * [流浪漢指南](zh/getting_started_vagrant.md) | ||
| 24 | * [構建/編譯器指令](zh/getting_started_make_guide.md) | ||
| 25 | * [刷新固件](zh/flashing.md) | ||
| 26 | * [定制功能](zh/custom_quantum_functions.md) | ||
| 27 | * [鍵盤映射概述](zh/keymap.md) | ||
| 28 | |||
| 29 | * [硬件](zh/hardware.md) | ||
| 30 | * [AVR處理器](zh/hardware_avr.md) | ||
| 31 | * [司機](zh/hardware_drivers.md) | ||
| 32 | |||
| 33 | * 參考 | ||
| 34 | * [Keyboard Guidelines](zh/hardware_keyboard_guidelines.md) | ||
| 35 | * [Config Options](zh/config_options.md) | ||
| 36 | * [Keycodes](zh/keycodes.md) | ||
| 37 | * [Documentation Best Practices](zh/documentation_best_practices.md) | ||
| 38 | * [Documentation Templates](zh/documentation_templates.md) | ||
| 39 | * [Glossary](zh/reference_glossary.md) | ||
| 40 | * [Unit Testing](zh/unit_testing.md) | ||
| 41 | * [Useful Functions](zh/ref_functions.md) | ||
| 42 | * [Configurator Support](zh/reference_configurator_support.md) | ||
| 43 | |||
| 44 | * [特點](zh/features.md) | ||
| 45 | * [Basic Keycodes](zh/keycodes_basic.md) | ||
| 46 | * [Quantum Keycodes](zh/quantum_keycodes.md) | ||
| 47 | * [Advanced Keycodes](zh/feature_advanced_keycodes.md) | ||
| 48 | * [Audio](zh/feature_audio.md) | ||
| 49 | * [Auto Shift](zh/feature_auto_shift.md) | ||
| 50 | * [Backlight](zh/feature_backlight.md) | ||
| 51 | * [Bluetooth](zh/feature_bluetooth.md) | ||
| 52 | * [Bootmagic](zh/feature_bootmagic.md) | ||
| 53 | * [Combos](zh/feature_combo) | ||
| 54 | * [Command](zh/feature_command.md) | ||
| 55 | * [Dynamic Macros](zh/feature_dynamic_macros.md) | ||
| 56 | * [Encoders](zh/feature_encoders.md) | ||
| 57 | * [Grave Escape](zh/feature_grave_esc.md) | ||
| 58 | * [Key Lock](zh/feature_key_lock.md) | ||
| 59 | * [Layouts](zh/feature_layouts.md) | ||
| 60 | * [Leader Key](zh/feature_leader_key.md) | ||
| 61 | * [Macros](zh/feature_macros.md) | ||
| 62 | * [Mouse Keys](zh/feature_mouse_keys.md) | ||
| 63 | * [One Shot Keys](zh/feature_advanced_keycodes.md#one-shot-keys) | ||
| 64 | * [Pointing Device](zh/feature_pointing_device.md) | ||
| 65 | * [PS/2 Mouse](zh/feature_ps2_mouse.md) | ||
| 66 | * [RGB Lighting](zh/feature_rgblight.md) | ||
| 67 | * [RGB Matrix](zh/feature_rgb_matrix.md) | ||
| 68 | * [Space Cadet Shift](zh/feature_space_cadet_shift.md) | ||
| 69 | * [Space Cadet Shift Enter](zh/feature_space_cadet_shift_enter.md) | ||
| 70 | * [Stenography](zh/feature_stenography.md) | ||
| 71 | * [Swap Hands](zh/feature_swap_hands.md) | ||
| 72 | * [Tap Dance](zh/feature_tap_dance.md) | ||
| 73 | * [Terminal](zh/feature_terminal.md) | ||
| 74 | * [Thermal Printer](zh/feature_thermal_printer.md) | ||
| 75 | * [Unicode](zh/feature_unicode.md) | ||
| 76 | * [Userspace](zh/feature_userspace.md) | ||
| 77 | * [US ANSI Shifted Keys](zh/keycodes_us_ansi_shifted.md) | ||
| 78 | |||
| 79 | * 對於製造商和遊戲模組 | ||
| 80 | * [Hand Wiring Guide](zh/hand_wire.md) | ||
| 81 | * [ISP Flashing Guide](zh/isp_flashing_guide.md) | ||
| 82 | * [ARM Debugging Guide](zh/arm_debugging.md) | ||
| 83 | * [I2C Driver](zh/i2c_driver.md) | ||
| 84 | |||
| 85 | * 為了更深入的了解 | ||
| 86 | * [How Keyboards Work](zh/how_keyboards_work.md) | ||
| 87 | * [Understanding QMK](zh/understanding_qmk.md) | ||
| 88 | |||
| 89 | * 其它主題 | ||
| 90 | * [Using Eclipse with QMK](zh/eclipse.md) | ||
| 91 | |||
| 92 | * QMK內部(進行中) | ||
| 93 | * [Defines](zh/internals_defines.md) | ||
| 94 | * [Input Callback Reg](zh/internals_input_callback_reg.md) | ||
| 95 | * [Midi Device](zh/internals_midi_device.md) | ||
| 96 | * [Midi Device Setup Process](zh/internals_midi_device_setup_process.md) | ||
| 97 | * [Midi Util](zh/internals_midi_util.md) | ||
| 98 | * [Send Functions](zh/internals_send_functions.md) | ||
| 99 | * [Sysex Tools](zh/internals_sysex_tools.md) | ||
