Peter Johanson
84ce6b066a
fix(docs): Add permanent redict to zmk.dev domain.
3 years ago
Peter Johanson
3f4839ec96
refactor: Move to new zmk.dev domain name.
3 years ago
Peter Johanson
ba45aaa81b
chore(docs): Bump prettier, and reformat w/ it.
...
* Bump to prettier 2.3.1.
* Re-run prettier:format to apply updated format.
3 years ago
dependabot[bot]
22800455e2
chore(deps): bump react-toastify from 6.0.9 to 7.0.4 in /docs
...
Bumps [react-toastify](https://github.com/fkhadra/react-toastify ) from 6.0.9 to 7.0.4.
- [Release notes](https://github.com/fkhadra/react-toastify/releases )
- [Commits](https://github.com/fkhadra/react-toastify/compare/v6.0.9...v7.0.4 )
---
updated-dependencies:
- dependency-name: react-toastify
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
dependabot[bot]
c83dea3742
chore(deps): bump react and react-dom in /docs
...
Bumps [react](https://github.com/facebook/react/tree/HEAD/packages/react ) and [react-dom](https://github.com/facebook/react/tree/HEAD/packages/react-dom ). These dependencies needed to be updated together.
Updates `react` from 16.14.0 to 17.0.2
- [Release notes](https://github.com/facebook/react/releases )
- [Changelog](https://github.com/facebook/react/blob/master/CHANGELOG.md )
- [Commits](https://github.com/facebook/react/commits/v17.0.2/packages/react )
Updates `react-dom` from 16.14.0 to 17.0.2
- [Release notes](https://github.com/facebook/react/releases )
- [Changelog](https://github.com/facebook/react/blob/master/CHANGELOG.md )
- [Commits](https://github.com/facebook/react/commits/v17.0.2/packages/react-dom )
---
updated-dependencies:
- dependency-name: react
dependency-type: direct:production
update-type: version-update:semver-major
- dependency-name: react-dom
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
Peter Johanson
7323f78a37
fix(docs): Upgrade docusaurus, webpack/loaders.
...
Upgrade to the new Docusaurus 2 beta release, which also required
upgrades to newer Webpack@5, and some API fixes for TOC changes.
3 years ago
Martin Eberhardt
87ee2304a1
feat(docs): Add icon legend to the feature matrix
...
Add icon legend to the feature matrix
3 years ago
dependabot[bot]
33f611cc5c
chore(deps): bump react-copy-to-clipboard from 5.0.2 to 5.0.3 in /docs
...
Bumps [react-copy-to-clipboard](https://github.com/nkbt/react-copy-to-clipboard ) from 5.0.2 to 5.0.3.
- [Release notes](https://github.com/nkbt/react-copy-to-clipboard/releases )
- [Commits](https://github.com/nkbt/react-copy-to-clipboard/compare/v5.0.2...v5.0.3 )
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
Dom H
faa90be1ba
docs(codes): Use LSHIFT/RSHIFT in keymap upgrader
3 years ago
Dom H
06a85f944f
docs(codes): Refer to LSHIFT instead of LSHFT
...
`LSHIFT` is slightly more intuitive and should result in fewer user
errors.
3 years ago
Dom H
52ee082692
docs(codes): Add LSHIFT and RSHIFT aliases
3 years ago
Ivan Smirnov
bb32005474
fix(docs): Update macos GCC embedded section with brew cmd
...
* 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.
3 years ago
Christian Stücklberger
8196b1d46b
fix(docs): Add missing semicolon to examples
...
Co-authored-by: Christian Stücklberger <christian.stuecklberger@ergon.ch>
3 years ago
dependabot[bot]
5b86fdd876
chore(deps-dev): bump eslint-plugin-mdx from 1.8.2 to 1.13.0 in /docs
...
Bumps [eslint-plugin-mdx](https://github.com/mdx-js/eslint-mdx ) from 1.8.2 to 1.13.0.
- [Release notes](https://github.com/mdx-js/eslint-mdx/releases )
- [Changelog](https://github.com/mdx-js/eslint-mdx/blob/master/CHANGELOG.md )
- [Commits](https://github.com/mdx-js/eslint-mdx/compare/v1.8.2...v1.13.0 )
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
dependabot[bot]
c735bb8de6
chore(deps): bump react-dom from 16.13.1 to 16.14.0 in /docs
...
Bumps [react-dom](https://github.com/facebook/react/tree/HEAD/packages/react-dom ) from 16.13.1 to 16.14.0.
- [Release notes](https://github.com/facebook/react/releases )
- [Changelog](https://github.com/facebook/react/blob/master/CHANGELOG.md )
- [Commits](https://github.com/facebook/react/commits/v16.14.0/packages/react-dom )
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
dependabot[bot]
f26da9cd4b
chore(deps): bump @fortawesome/free-solid-svg-icons in /docs
...
Bumps [@fortawesome/free-solid-svg-icons ](https://github.com/FortAwesome/Font-Awesome ) from 5.15.1 to 5.15.3.
- [Release notes](https://github.com/FortAwesome/Font-Awesome/releases )
- [Changelog](https://github.com/FortAwesome/Font-Awesome/blob/master/CHANGELOG.md )
- [Commits](https://github.com/FortAwesome/Font-Awesome/compare/5.15.1...5.15.3 )
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
dependabot[bot]
b09b1f3c8c
chore(deps): bump @fortawesome/react-fontawesome in /docs
...
Bumps [@fortawesome/react-fontawesome ](https://github.com/FortAwesome/react-fontawesome ) from 0.1.12 to 0.1.14.
- [Release notes](https://github.com/FortAwesome/react-fontawesome/releases )
- [Changelog](https://github.com/FortAwesome/react-fontawesome/blob/master/CHANGELOG.md )
- [Commits](https://github.com/FortAwesome/react-fontawesome/commits/0.1.14 )
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
dependabot[bot]
8a39683965
chore(deps-dev): bump eslint-plugin-react from 7.21.5 to 7.23.2 in /docs
...
Bumps [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react ) from 7.21.5 to 7.23.2.
- [Release notes](https://github.com/yannickcr/eslint-plugin-react/releases )
- [Changelog](https://github.com/yannickcr/eslint-plugin-react/blob/master/CHANGELOG.md )
- [Commits](https://github.com/yannickcr/eslint-plugin-react/compare/v7.21.5...v7.23.2 )
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
dependabot[bot]
a006970825
chore(deps): bump react from 16.13.1 to 16.14.0 in /docs
...
Bumps [react](https://github.com/facebook/react/tree/HEAD/packages/react ) from 16.13.1 to 16.14.0.
- [Release notes](https://github.com/facebook/react/releases )
- [Changelog](https://github.com/facebook/react/blob/master/CHANGELOG.md )
- [Commits](https://github.com/facebook/react/commits/v16.14.0/packages/react )
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
Peter Johanson
e19cf7912d
fix(docs): Updated eslint config for unified prettier setup.
3 years ago
dependabot[bot]
ea57f62048
chore(deps-dev): bump eslint-config-prettier in /docs
...
Bumps [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier ) from 6.14.0 to 8.3.0.
- [Release notes](https://github.com/prettier/eslint-config-prettier/releases )
- [Changelog](https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md )
- [Commits](https://github.com/prettier/eslint-config-prettier/compare/v6.14.0...v8.3.0 )
Signed-off-by: dependabot[bot] <support@github.com>
3 years ago
dependabot[bot]
fa2e51b528
chore(deps-dev): bump eslint from 7.12.0 to 7.25.0 in /docs ( #773 )
...
Bumps [eslint](https://github.com/eslint/eslint ) from 7.12.0 to 7.25.0.
- [Release notes](https://github.com/eslint/eslint/releases )
- [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md )
- [Commits](https://github.com/eslint/eslint/compare/v7.12.0...v7.25.0 )
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
3 years ago
Piotr Gnus
8e235a2d65
fix(docs): Readjusted colors for dark theme for OSes in docs
...
Previously the colors of operating systems were the same both for dark
and light color scheme. That's not a major issue, but adjusting the
colors for the dark theme to better match the theme looks like an
improvement.
Colors were just darkened by reversing the lightness of each color taken
from the dark theme.
3 years ago
Piotr Gnus
96bd927be2
feat(docs): Added support for prefers-color-scheme in docs
...
Now, instead of always defaulting to light theme, documentation, docs
will default to the color scheme based by the user preference (reported
by web browser as a `prefers-color-scheme` media query).
It is still possible for user to change the theme by using the switch
next to the search box. His preference will be remembered.
3 years ago
Michael van Eerd
fadb508671
fix(docs) omit layers -1 example, clarify it defaults when omitted ( #757 )
...
* fix(docs) omit layers -1 example, clarify
* comment, simplify description
* remove 'the'
3 years ago
measlesbagel
3893d50e13
Docs: added mod morph page ( #749 )
...
* 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
3 years ago
Nick Winans
4ef11ac4aa
feat(docs): Add power profiler
4 years ago
Cody McGinnis
d956193251
change "Under Development" to "Beta Testing"
4 years ago
Cody McGinnis
ac50e741be
move the information to its own page
4 years ago
Cody McGinnis
daf10d9741
feat(docs): add information for testing PRs
4 years ago
Megamannen
a7c6e080a7
Fix broken link in documentation (encoders) ( #707 )
...
* Update encoders.md
Link to "New Keyboard Shield" didn't work
* Update encoders.md
Forgot hash-link
4 years ago
Megamannen
0a7491af87
Add detailed pin mapping explanation to underglow docs ( #709 )
...
* 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
4 years ago
Okke Formsma
0c1940bb79
feature(hold-tap): no-hold-flash for retro taps
...
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.
4 years ago
Okke Formsma
89ed816c67
feature(hold-tap): Retro tapping
4 years ago
Okke Formsma
af9d6e9b05
style(hold-tap)!: Write hold-tap params with dashes
...
tapping_term_ms -> tapping-term-ms
quick_tap_ms -> quick-tap-ms
The old style works, although it's deprecated.
4 years ago
Joel Spadin
24ed1a8eaa
docs(vscode): add more info for compile_commands.json path
4 years ago
Joel Spadin
0955ffef65
docs: Add docs for setting up vscode
...
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.
4 years ago
Pierre Constantineau
b67156b3f4
feat(docs): Update to BlueMicro_BLE Features
4 years ago
Pete Johanson
ae5056d680
Update docs/docs/behaviors/bluetooth.md
...
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
4 years ago
Jonathan Rascher
1368a6481e
docs: Explain ZMK stays connected to inactive host
...
This behavior was not obvious to me, and I actually considered reporting
it as a bug until @Nicell explained to me on Discord that it's WAI. :)
4 years ago
KemoNine
cd503ed17b
Feat combo layers ( #661 )
...
feat(combos): add layer filtering
Co-authored-by: KemoNine <mcrosson@kemonine.info>
4 years ago
y4m4ym
9205ea1c70
fix(setup): Fix index to MakerDiary m.2 board
4 years ago
Okke Formsma
9a7908b632
behaviors(hold-tap): Implement quick_tap_ms (TAPPING_FORCE_HOLD)
...
Tap-and-hold a hold-tap to hold the tap behavior so it can repeat.
After a tap, if the same key is pressed within `quick_tap_ms`, the
tap behavior is always picked.
This is useful for things like `&ht LSHFT BACKSPACE` where holding
the backspace is required.
Implements #288 .
4 years ago
Aaron Nunley
bcc3d9b5a6
Update build/flash documentation.
...
Updated docs for the build and flash to have similar content to the new board page.
Added a bit about DFU in case someone were searching for that term.
4 years ago
Aaron Nunley
592b98cd12
npm run prettier:format
4 years ago
Aaron Nunley
100d06ae8b
Update docs for testing a new shield.
...
Clarifying the need for `west flash` in a dockerized environment and providing a high-level overview of testing a board with UF2 support.
4 years ago
Nick Winans
f39121f82e
fix(docs): Remove comment about here being four profiles for splits
4 years ago
innovaker
40694a0969
docs: remove redundant slash from "docs/" navigation item
...
Aligns with the blog item.
PR: #608
4 years ago
Nick Winans
ddc5cbdca2
fix(docs): Set description to our tagline
4 years ago
Nick Winans
cba85d400d
fix(docs): Only show push workflow builds in link
4 years ago