summaryrefslogtreecommitdiff
path: root/docs/docs
AgeCommit message (Collapse)Author
2021-10-10docs(docs): Document up-to-date Node.js repoJonathan Rascher
For example, Debian Bullseye (current stable) packages Node.js version 12, which is too old to build the docs successfully. At least version 14 is required, and version 16 is current. General advice seems to be to install from the NodeSource repo instead of your distro's repo, so I added a suggestion to the docs.
2021-09-25feat(docs): Update documentation to match new Pro Micro nodesNick Winans
2021-09-25fix(docs): Update split naming systemNick Winans
2021-09-24fix(docs): Typo EC11_CONFIGRichard Titmuss
This should be CONFIG_EC11
2021-09-22fix(docs): Remove build.yml from new shield stepsDom H
2021-09-17fix(docs): Set "Mouse Keys" as "Under Development"Dom H
2021-09-17fix(docs) add `BT_PRV` as suggestedMichael van Eerd
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2021-09-17fix(docs) Bluetooth behavior typoMichael van Eerd
2021-09-17fix(docs) Move Number of Profiles note downMichael van Eerd
2021-09-17feat(docs) Clarify Bluetooth profile pairingMichael van Eerd
2021-09-17fix(docs): Remove unnecessary security warning for MacOSRichard Titmuss
The security warning applies for downloaded executables. If you are following the instructions the toolchain is installed with brew and the security warning does not apply. This is explained in the removed link.
2021-09-14feat(docs): Add note to clarify shared .conf files do not apply outside ↵Cem Aksoylar
zmk-config
2021-09-11refactor(docs): Remove build.yml for new shield.Peter Johanson
* No longer recommending that all new shields get added to the build matrix in `build.yml`, so we avoid conflicts.
2021-09-11docs: Add docs on hardware metadata files.Peter Johanson
2021-09-11feat(docs): Add dynamic hardware list component.Peter Johanson
2021-08-12fix typochad3814
"load your newly flashed firmware" not "load your newfly flashed fireware"
2021-08-12fix(docs): Standardize all internal linksNick Winans
2021-08-12fix(docs): Fix "All" typochad3814
2021-08-08fix(docs): Appease PrettierJoel Spadin
Fixed code formatting in docs files.
2021-08-04Add warning about peripheral encoders.Peter Johanson
2021-07-27Update docs to use “SQT” instead of “QUOTE” (#839)Felix Sargent
* Update default keymap to use SQT Instead of the invalid “QUOTE” * Update keymap-example-file.md * Update docs/docs/keymap-example.md Co-authored-by: Pete Johanson <peter@peterjohanson.com> Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2021-07-18docs(setup): replace `zephyr-west-action` with `zmk-docker`innovaker
This should've been changed after #481. See: https://github.com/zmkfirmware/zmk/pull/481 PR: https://github.com/zmkfirmware/zmk/pull/845
2021-07-17docs: bump Zephyr documentation links to Zephyr v2.5.0innovaker
PR: https://github.com/zmkfirmware/zmk/pull/736
2021-07-17docs(setup): add `x86_64-linux` to Zephyr SDK setup filenameinnovaker
See: zmkfirmware/zmk-docker@b8341e185ab694f7c596b81d03ada34ac76d2f1c PR: https://github.com/zmkfirmware/zmk/pull/736
2021-07-17docs(setup): bump `ZSDK_VERSION` to `0.12.4`innovaker
PR: https://github.com/zmkfirmware/zmk/pull/736
2021-07-15feat(docs): Add nice!nano v2 to scripts, actions, and documentationNick Winans
asdf asdf asdf
2021-06-16docs(setup): fix whitespace in Fedora toolchain install commandinnovaker
Aligns Fedora whitespace with Debian.
2021-06-16docs(setup): remove extra slash from Fedora toolchain install commandinnovaker
2021-06-16docs(setup): fix whitespace mismatch in host dependenciesinnovaker
Replaces spaces with tabs (bzip2).
2021-06-10refactor: Move to new zmk.dev domain name.Peter Johanson
2021-06-09chore(docs): Bump prettier, and reformat w/ it.Peter Johanson
* Bump to prettier 2.3.1. * Re-run prettier:format to apply updated format.
2021-06-09fix(docs): Upgrade docusaurus, webpack/loaders.Peter Johanson
Upgrade to the new Docusaurus 2 beta release, which also required upgrades to newer Webpack@5, and some API fixes for TOC changes.
2021-06-08feat(docs): Add icon legend to the feature matrixMartin Eberhardt
Add icon legend to the feature matrix
2021-06-08docs(codes): Refer to LSHIFT instead of LSHFTDom H
`LSHIFT` is slightly more intuitive and should result in fewer user errors.
2021-06-08fix(docs): Update macos GCC embedded section with brew cmdIvan Smirnov
* Update macos GCC embedded section with brew cmd Brew has a cask for GCC embedded, so we can make this guide more user friendly by providing it.
2021-05-19fix(docs): Add missing semicolon to examplesChristian Stücklberger
Co-authored-by: Christian Stücklberger <christian.stuecklberger@ergon.ch>
2021-04-15fix(docs) omit layers -1 example, clarify it defaults when omitted (#757)Michael van Eerd
* fix(docs) omit layers -1 example, clarify * comment, simplify description * remove 'the'
2021-04-05Docs: added mod morph page (#749)measlesbagel
* docs(behaviors): add mod-morph doc page * docs(behaviors): add mod-morph doc page * docs(mod-morph): add note about sent modifiers * docs(mod-morph): fixed prettier formatting
2021-03-10change "Under Development" to "Beta Testing"Cody McGinnis
2021-03-10move the information to its own pageCody McGinnis
2021-03-10feat(docs): add information for testing PRsCody McGinnis
2021-03-03Fix broken link in documentation (encoders) (#707)Megamannen
* Update encoders.md Link to "New Keyboard Shield" didn't work * Update encoders.md Forgot hash-link
2021-03-03Add detailed pin mapping explanation to underglow docs (#709)Megamannen
* Update underglow.md Updated the documentation according to my current understandring of how to pin-mapping works, also split the chapter into a nrf-section and a non-nrf-section since that information isn't applicable to both * Ran prettier and updated pin reference according to suggestion
2021-02-24feature(hold-tap): no-hold-flash for retro tapsOkke Formsma
This is an improvement on retro-tap, solving the 'flashing hold' issue users people experience. When the tapping-term expires, the hold key is normally pressed. When retro-tap is enabled, this is undesirable; only an interrupted hold-tap should trigger the hold behavior. This change disables the hold behavior for the 'STATUS_HOLD_TIMER' state when retro-tap is enabled, and makes sure the 'STATUS_HOLD_INTERRUPT' state will be triggered when appropriate.
2021-02-24feature(hold-tap): Retro tappingOkke Formsma
2021-02-10style(hold-tap)!: Write hold-tap params with dashesOkke Formsma
tapping_term_ms -> tapping-term-ms quick_tap_ms -> quick-tap-ms The old style works, although it's deprecated.
2021-02-09docs(vscode): add more info for compile_commands.json pathJoel Spadin
2021-02-09docs: Add docs for setting up vscodeJoel Spadin
Added a docs page with tips for setting up VS Code's code completion to work in ZMK's source files. Info for other IDEs can be added here later as needed.
2021-02-08feat(docs): Update to BlueMicro_BLE FeaturesPierre Constantineau
2021-02-04Update docs/docs/behaviors/bluetooth.mdPete Johanson
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-21 05:24:14 +0000