Caleb Lightfoot
3adbdffd0c
docs: Add wired split FAQ
4 years ago
Caleb Lightfoot
4a8a6c58fb
docs: Remove outdated HID note
...
Removed outdated HID note from key-press.md
4 years ago
krikun98
f60439802d
Jian shield
4 years ago
krikun98
3d030ec2ab
Jorne shield
4 years ago
Chiyuan Zhang
9388b24e7a
zmk-config mounting based on docker volume
4 years ago
innovaker
28a4f33ee7
refactor(docs): Extract keymap examples into their own files
...
Eases maintenance and promotes reuse.
4 years ago
innovaker
18079e3bd3
fix(docs): Remove obsolete VID/PID CMake error
...
This was obsoleted by 36d3d01a22
.
4 years ago
innovaker
6cf13f6b80
docs(key-press): Change `codes` to `usages`
...
`usages` is a more accurate term in this context.
4 years ago
innovaker
2871dca9bf
refactor(docs): Change `behavior` to `behaviors`
...
Makes a better URL.
4 years ago
innovaker
a685d88744
refactor(docs): Change `feature` to `features`
...
Makes a better URL.
4 years ago
innovaker
aa8d0c1c79
refactor(docs): Remove explicit document ids (part 2)
...
This was missed in: 4d42e792c5
4 years ago
innovaker
4d42e792c5
refactor(docs): Remove explicit document ids
...
Aligns older documents with newer file-based ids.
4 years ago
Okke Formsma
d5cc504b3a
docs: update modifier docs
4 years ago
Nick
ae51000d60
fix(underglow): Switch from legacy SPI to SPIM
4 years ago
Pete Johanson
7d16186b7a
fix(ble): Remove unpair combo code.
...
* Favor the settings reset images for this.
4 years ago
Pete Johanson
edcfe380fe
fix(blog): Quefrency typo fix.
4 years ago
Pete Johanson
9fe1793691
feat(blog): SOTF #3
4 years ago
Nick
0be904c34f
fix(underglow): Add CONFIG_ to underglow Kconfigs
4 years ago
Okke Formsma
0d02441abe
docs(codes): add modifier functions
...
Refactor and expand codes documentation to include modifier functions.
Closes #330 .
4 years ago
innovaker
5d04110a58
docs(key-press): Update for standardized keys
...
Replace existing HID Usage Tables link with links to the new codes documentation.
4 years ago
innovaker
642ec46c1f
docs(intro): Update for standardized keys
...
Update links to the new codes documentation.
4 years ago
innovaker
ff638eb010
docs(codes): Add (key) codes documentation
...
Create codes documentation for standardized keys.
Closes #218 . Fixes #308 . Ref #21 .
4 years ago
Pete Johanson
eff1b8223b
refactor(keys): Unify usage page.
...
* Remove need for separate `&cp` behavior, but
keep it for now for backward compat.
* Refactor sensor inc/dec as well.
4 years ago
innovaker
5f83568a93
docs(key press): Replace deprecated `NUM_1` with `N1`
...
This should've been changed in: b8f6d52ae5
4 years ago
innovaker
651204c121
docs: Reformat example keymaps
...
Align to wider columns to improve readability for newcomers.
4 years ago
innovaker
b8f6d52ae5
docs: Replace deprecated key names
...
Follow-up to #21 .
4 years ago
Joel Spadin
c3e7742f9c
fix(docs): remove incorrect defines for outputs
...
The output selection behaviors page still referenced defines that were
removed while reviewing the PR. Updated the docs to match the code.
4 years ago
Nick
274fdec783
Add blog post about #322
4 years ago
Pete Johanson
fe62929af8
feat(docs): Add eslint and prettier GH Actions.
4 years ago
innovaker
a1dd216519
docs: formatted with prettier
4 years ago
Okke Formsma
4f258efbf1
initial implementation for modifiers
...
https://github.com/zmkfirmware/zmk/issues/86
4 years ago
Chiyuan Zhang
a9e729b427
make note about keyboard name more explicit
4 years ago
Chiyuan Zhang
9b941b7509
tweak doc according to PR feedback
4 years ago
Chiyuan Zhang
e7cb863a41
update doc for new shield in user repo
4 years ago
Evan
a32d14cc19
Add Github.com personal token to prerequisites.
4 years ago
innovaker
4672a0cbb5
docs(outputs): run prettier on outputs.md ( #317 )
...
Fixes #269
4 years ago
Pete Johanson
1766b090ee
feat(docs): Warn of battery life impact of logging
4 years ago
Pete Johanson
7e0924107c
feat(docs): Link to outputs behavior docs.
4 years ago
Joel Spadin
2fe1fbb526
feat(endpoints): rename behavior to outputs
...
"Outputs" is probably easier for most people to understand than "endpoints".
4 years ago
Joel Spadin
600bba25f0
feat(endpoints): add preferred endpoint setting
...
Added a new setting to remember the user's preferred endpoint. When both USB and
BLE are connected, the preferred endpoint will be used.
Added a new behavior to control this setting. It supports commands:
&end END_USB - Prefer USB output
&end END_BLE - Prefer BLE output
&end END_TOG - Toggle between USB and BLE
4 years ago
Pete Johanson
cb922fd8a2
feat(docs): Add Boardsource 3x4 to hardware list.
4 years ago
Jay Greco
d90592aac5
Add NIBBLE shield
...
+ Added required files for nullbits NIBBLE
4 years ago
Pete Johanson
571d045c75
fix(docs): Explicit CC-BY-NC-SA license for docs.
4 years ago
innovaker
806ea545f8
docs: Set netlify node version to lts/*
...
Prerequisite of #218 and PR #308 .
4 years ago
Nick
1ac78498eb
docs: Set prettier endOfLine to auto
...
As discussed in PR #301 .
4 years ago
Nick
fd892d53cd
fix: eslint proptype errors
4 years ago
innovaker
288e60ea97
docs: Format docs with prettier
...
npx prettier --write .
4 years ago
innovaker
aefcc592f2
docs: Add eslint-mdx support
...
Official guidelines:
https://github.com/mdx-js/eslint-mdx
Steps taken:
npm i -D eslint-plugin-mdx
Edit .eslintrc.js
4 years ago
innovaker
18d4d619e4
docs: Add prettier support
...
Official guidelines:
https://prettier.io/docs/en/install.html
https://prettier.io/docs/en/integrating-with-linters.html
https://github.com/prettier/eslint-config-prettier
Steps taken:
npm install --save-dev --save-exact prettier
Create .prettierignore
Create .prettierrc.js
npm install --save-dev eslint-config-prettier
Edit .eslintrc.js
4 years ago
innovaker
ab65bf49db
docs: Add eslint support
...
Official guidelines:
https://eslint.org/docs/user-guide/getting-started
Steps taken:
npm install eslint --save-dev
npx eslint --init
Create .eslintignore
Edit .eslintrc.js (tweaks)
4 years ago