diff options
author | Nick Brassel <[email protected]> | 2024-05-30 12:00:41 +1000 |
---|---|---|
committer | GitHub <[email protected]> | 2024-05-30 12:00:41 +1000 |
commit | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch) | |
tree | 334e3bf41c8554d4bee73a140822f95f60eb64e9 /docs/index.md | |
parent | 395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff) | |
download | qmk_firmware-6ef97172889ccd5db376b2a9f8825489e24fdac4.tar.gz qmk_firmware-6ef97172889ccd5db376b2a9f8825489e24fdac4.zip |
Vitepress conversion of docs. (#23795)
Diffstat (limited to 'docs/index.md')
-rw-r--r-- | docs/index.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..91f27a8a80 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,40 @@ +# Quantum Mechanical Keyboard Firmware + +## What is QMK Firmware? + +QMK (*Quantum Mechanical Keyboard*) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains [QMK Firmware](https://github.com/qmk/qmk_firmware), [QMK Configurator](https://config.qmk.fm), [QMK Toolbox](https://github.com/qmk/qmk_toolbox), [qmk.fm](https://qmk.fm), and this documentation with the help of community members like you. + +## Get Started + +<div class="flex-container"> + +::: tip +**Basic** [QMK Configurator](newbs_building_firmware_configurator) <br> +::: +User friendly graphical interfaces, no programming knowledge required. + +::: tip +**Advanced** [Use The Source](newbs) <br> +::: +More powerful, but harder to use. + +</div> + +## Make It Yours + +QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your [keymap](keymap), and changing the [keycodes](keycodes). + +## Need help? + +Check out the [support page](support) to see how you can get help using QMK. + +## Give Back + +There are a lot of ways you can contribute to the QMK Community. The easiest way to get started is to use it and spread the word to your friends. + +* Help people out on our forums and chat rooms: + * [/r/olkb](https://www.reddit.com/r/olkb/) + * [Discord Server](https://discord.gg/Uq7gcHh) +* Contribute to our documentation by clicking "Edit This Page" at the bottom +* [Report a bug](https://github.com/qmk/qmk_firmware/issues/new/choose) +* [Open a Pull Request](contributing) |