krikun98
3d030ec2ab
Jorne shield
2020-11-17 16:23:39 +00:00
Chiyuan Zhang
9388b24e7a
zmk-config mounting based on docker volume
2020-11-16 22:49:20 -05:00
innovaker
28a4f33ee7
refactor(docs): Extract keymap examples into their own files
...
Eases maintenance and promotes reuse.
2020-11-16 21:39:38 -05:00
innovaker
18079e3bd3
fix(docs): Remove obsolete VID/PID CMake error
...
This was obsoleted by 36d3d01a22
.
2020-11-16 17:33:59 -05:00
innovaker
6cf13f6b80
docs(key-press): Change codes
to usages
...
`usages` is a more accurate term in this context.
2020-11-16 17:32:51 -05:00
innovaker
2871dca9bf
refactor(docs): Change behavior
to behaviors
...
Makes a better URL.
2020-11-16 15:33:44 -05:00
innovaker
a685d88744
refactor(docs): Change feature
to features
...
Makes a better URL.
2020-11-16 15:33:44 -05:00
innovaker
aa8d0c1c79
refactor(docs): Remove explicit document ids (part 2)
...
This was missed in: 4d42e792c5
2020-11-12 07:42:48 -05:00
innovaker
4d42e792c5
refactor(docs): Remove explicit document ids
...
Aligns older documents with newer file-based ids.
2020-11-11 23:40:49 -05:00
Okke Formsma
d5cc504b3a
docs: update modifier docs
2020-11-11 14:04:35 -05:00
Nick
ae51000d60
fix(underglow): Switch from legacy SPI to SPIM
2020-11-10 23:06:29 -05:00
Pete Johanson
0031f9bd4d
Merge pull request #357 from petejohanson/ble/remove-unpair-combo
...
fix(ble): Remove unpair combo code.
2020-11-10 15:04:28 -05:00
Pete Johanson
7d16186b7a
fix(ble): Remove unpair combo code.
...
* Favor the settings reset images for this.
2020-11-10 14:53:03 -05:00
Nick Winans
413a917d14
Merge branch 'main' into underglow/add-config_
2020-11-10 13:31:11 -06:00
Pete Johanson
edcfe380fe
fix(blog): Quefrency typo fix.
2020-11-09 17:00:52 -05:00
Pete Johanson
9fe1793691
feat(blog): SOTF #3
2020-11-09 16:12:03 -05:00
Nick
0be904c34f
fix(underglow): Add CONFIG_ to underglow Kconfigs
2020-11-08 10:33:56 -06:00
Okke Formsma
0d02441abe
docs(codes): add modifier functions
...
Refactor and expand codes documentation to include modifier functions.
Closes #330 .
2020-11-07 12:00:19 -05:00
innovaker
5d04110a58
docs(key-press): Update for standardized keys
...
Replace existing HID Usage Tables link with links to the new codes documentation.
2020-11-06 15:02:12 -05:00
innovaker
642ec46c1f
docs(intro): Update for standardized keys
...
Update links to the new codes documentation.
2020-11-06 15:02:12 -05:00
innovaker
ff638eb010
docs(codes): Add (key) codes documentation
...
Create codes documentation for standardized keys.
Closes #218 . Fixes #308 . Ref #21 .
2020-11-06 15:02:12 -05:00
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.
2020-11-05 14:55:40 -05:00
innovaker
5f83568a93
docs(key press): Replace deprecated NUM_1
with N1
...
This should've been changed in: b8f6d52ae5
2020-11-05 11:47:34 -05:00
innovaker
651204c121
docs: Reformat example keymaps
...
Align to wider columns to improve readability for newcomers.
2020-11-03 23:50:54 -05:00
innovaker
b8f6d52ae5
docs: Replace deprecated key names
...
Follow-up to #21 .
2020-11-03 23:50:54 -05:00
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.
2020-11-03 19:38:56 -05:00
Nick
274fdec783
Add blog post about #322
2020-11-03 15:56:20 -05:00
Pete Johanson
fe62929af8
feat(docs): Add eslint and prettier GH Actions.
2020-11-03 15:02:41 -05:00
innovaker
a1dd216519
docs: formatted with prettier
2020-11-03 08:19:00 -05:00
Okke Formsma
4f258efbf1
initial implementation for modifiers
...
https://github.com/zmkfirmware/zmk/issues/86
2020-11-03 00:19:37 -05:00
Chiyuan Zhang
a9e729b427
make note about keyboard name more explicit
2020-11-02 23:30:03 -05:00
Chiyuan Zhang
9b941b7509
tweak doc according to PR feedback
2020-11-02 23:30:03 -05:00
Chiyuan Zhang
e7cb863a41
update doc for new shield in user repo
2020-11-02 23:30:03 -05:00
Evan
a32d14cc19
Add Github.com personal token to prerequisites.
2020-11-02 16:50:27 -05:00
innovaker
4672a0cbb5
docs(outputs): run prettier on outputs.md ( #317 )
...
Fixes #269
2020-10-31 12:00:02 -04:00
Pete Johanson
1766b090ee
feat(docs): Warn of battery life impact of logging
2020-10-31 00:30:19 -04:00
Pete Johanson
7e0924107c
feat(docs): Link to outputs behavior docs.
2020-10-31 00:23:16 -04:00
Joel Spadin
2fe1fbb526
feat(endpoints): rename behavior to outputs
...
"Outputs" is probably easier for most people to understand than "endpoints".
2020-10-28 18:15:05 -05:00
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
2020-10-28 18:15:05 -05:00
innovaker
806ea545f8
docs: Set netlify node version to lts/*
...
Prerequisite of #218 and PR #308 .
2020-10-26 22:55:15 +00:00
Pete Johanson
cb922fd8a2
feat(docs): Add Boardsource 3x4 to hardware list.
2020-10-27 23:32:44 -04:00
Jay Greco
d90592aac5
Add NIBBLE shield
...
+ Added required files for nullbits NIBBLE
2020-10-27 12:44:59 -07:00
Pete Johanson
3b9caaaf90
Merge pull request #304 from petejohanson/docs/cc-license-details
...
Explicitly license documentation as CC-BY-NC-SA.
2020-10-27 14:10:47 -04:00
Pete Johanson
2f09957ae2
Merge pull request #301 from innovaker/docs-eslint-prettier
...
docs: Add eslint, prettier and eslint-mdx support
2020-10-27 12:56:44 -04:00
Pete Johanson
c707ab45ef
Merge pull request #297 from Nicell/boards/reviung41
...
Add Reviung41 Shield Definitions
2020-10-27 00:27:17 -04:00
Pete Johanson
571d045c75
fix(docs): Explicit CC-BY-NC-SA license for docs.
2020-10-26 23:15:48 -04:00
Nick
1ac78498eb
docs: Set prettier endOfLine to auto
...
As discussed in PR #301 .
2020-10-26 05:28:31 +00:00
Nick
fd892d53cd
fix: eslint proptype errors
2020-10-25 23:45:28 +00:00
innovaker
288e60ea97
docs: Format docs with prettier
...
npx prettier --write .
2020-10-25 21:25:08 +00:00
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
2020-10-25 21:25:01 +00:00
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
2020-10-25 21:24:55 +00:00
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)
2020-10-25 21:23:16 +00:00
Pete Johanson
b1bfff5b5a
Merge pull request #264 from careyk007/setup_sh__curl_always_required
...
Add support for wget to setup.sh
2020-10-25 23:39:47 -04:00
innovaker
ca0bcc0ae4
docs: Add missing docusaurus scripts
...
Add:
- docusaurus serve
- docusaurus clear
2020-10-25 19:45:04 +00:00
Nick
7296b96797
Add Reviung41 Shield Definitions
2020-10-24 21:08:00 -05:00
Pete Johanson
518bcacba1
Merge pull request #280 from Tsquash/txpowerdocs
...
DocumentedTX Power Config in Troubleshooting
2020-10-23 12:36:28 -04:00
Caleb Lightfoot
1a6d373d16
Added Sentence For Link to Zephyr Docs
2020-10-21 19:57:46 -05:00
Caleb Lightfoot
d07a46a334
Changed Wording of Text
2020-10-21 19:44:49 -05:00
innovaker
0905302006
chore(docs): Docusaurus 2.0.0-alpha.66
2020-10-21 19:35:04 +01:00
innovaker
1e008728b7
chore(blog): Remove deprecated id: wip
...
Fix warning ...
2020-05-24-wip.md - 'id' header option is deprecated. Please use 'slug' option instead.
Follow-up to #286 .
2020-10-21 13:52:45 +01:00
innovaker
cd683b8dd6
chore(docs): Replace homePageId with slug: /
...
Fix warning ...
The docs plugin option homePageId=intro is deprecated. To make a doc the "home", prefer frontmatter: "slug: /"
Follow-up to #286 .
2020-10-21 13:52:25 +01:00
innovaker
99751ad376
chore(docs): Docusaurus 2.0.0-alpha.65
...
Closes #286 . Prerequisite of #218 .
2020-10-21 13:51:58 +01:00
innovaker
a796ee574f
fix(docs): Remove empty links
...
Prerequisite fixes for Docusaurus 2.0.0-alpha.65 (#286 ) which has stricter markdown rules.
2020-10-21 13:51:37 +01:00
Pete Johanson
ef37f17796
Merge pull request #109 from Nicell/underglow/state-persistence
...
Add RGB underglow state Kconfig and settings
2020-10-18 22:29:55 -04:00
Kellen Carey
4bd41b9bf9
add wget flag to example
2020-10-15 16:53:16 -07:00
Pete Johanson
a1387eb041
Merge pull request #250 from Tsquash/docs
...
Added Feature Matrix for Intro.md
2020-10-15 11:24:15 -04:00
Pete Johanson
548fa2a6eb
Merge pull request #277 from megamind4089/docs/ext-power
...
Added docs for external power output
2020-10-15 11:18:42 -04:00
Caleb Lightfoot
91b208faf3
Documented TX Power Config in Troubleshooting
2020-10-13 21:12:29 -05:00
Pete Johanson
b2cad7e597
fix(docs): Proper block for romac shield.
2020-10-13 19:50:24 -04:00
Pete Johanson
43c900f94a
feat: Add qaz to setup scripts.
2020-10-13 19:46:02 -04:00
Mega Mind
cc21167d57
Added docs for external power output
2020-10-14 00:27:32 +08:00
Pete Johanson
b193e5b1bc
Merge pull request #265 from kurtis-lew/actuallyissue138
...
Addressing #138 - ZMK Config Folders
2020-10-13 00:29:37 -04:00
Pete Johanson
94bc2c31b1
feat: Add a couple missing shields to user setup.
2020-10-13 00:23:25 -04:00
Pete Johanson
47cfcb42d2
Merge pull request #257 from kurtis-lew/issue138
...
Adressing Issue #181 - Split Keyboard Documentation
2020-10-13 00:04:12 -04:00
Caleb Lightfoot
e475260664
Revert "Increased Comprehension of Oled Footnote"
...
This reverts commit d4b83c3ebf
.
2020-10-12 19:06:40 -05:00
Caleb Lightfoot
d4b83c3ebf
Increased Comprehension of Oled Footnote
2020-10-12 18:52:29 -05:00
Pete Johanson
d0c6310434
Merge pull request #259 from Tsquash/DFU
...
Issue: #197 Added Setup Instructions for `dfu-util`
2020-10-12 11:08:21 -04:00
Pete Johanson
0d893e5fd2
Merge pull request #260 from Tsquash/PSscript
...
Issue #210 Document Setup.ps
2020-10-12 10:50:31 -04:00
Caleb Lightfoot
1ef21c57ea
added links to see progress of features.
2020-10-10 23:03:07 -05:00
Caleb Lightfoot
593d7ff781
made table completely visual; changed feature sentence
2020-10-10 22:40:14 -05:00
Tsquash
56ab812a67
fixed BLE part of table
2020-10-10 22:18:18 -05:00
Tsquash
229c8b4358
Added BlueMicro Collumn
2020-10-10 22:18:18 -05:00
Tsquash
21987d3385
update intro.md
2020-10-10 22:18:18 -05:00
Tsquash
d7bfe979c9
Fixed Footnote and added user config repo
2020-10-10 22:18:18 -05:00
Caleb Lightfoot
eb9dc37f00
fix table
2020-10-10 22:18:18 -05:00
Caleb Lightfoot
e2a845b2eb
removed checkmark from zmk oled
2020-10-10 22:18:18 -05:00
Caleb Lightfoot
93c5ae17ac
Uniformed Capitals, Added footnotes
2020-10-10 22:18:18 -05:00
Caleb Lightfoot
910e207dbc
Update Intro
...
changed intro wording and link to layer tap
Update intro.md
2020-10-10 22:18:18 -05:00
Tsquash
e740a83d68
Made columns wider
2020-10-10 22:17:52 -05:00
Tsquash
90b56a1941
added in dev
2020-10-10 22:17:52 -05:00
Tsquash
23e9cbcaf9
Added Table and fixed Feature sentence
...
added feature table
new feature sentence
2020-10-10 22:17:52 -05:00
kurtis-lew
677746014c
Addressing #138 - ZMK Config Folders
2020-10-10 19:33:47 -07:00
Kellen Carey
b738cc9d75
add option to use wget
2020-10-10 19:16:07 -07:00
Kellen Carey
f9e8866a52
add support for wget to setup.sh
2020-10-10 18:28:16 -07:00
Pete Johanson
a7e8655287
Merge pull request #256 from careyk007/check_directory_write_permissions_in_setup_script
...
Exit setup if no write permissions in directory
2020-10-10 20:09:55 -04:00
Kellen Carey
4aa45c6f40
update setup.ps1
2020-10-10 17:00:13 -07:00
Tsquash
d79811dd61
Changed setup script url
2020-10-10 14:39:12 -05:00
Tsquash
45f4ffc03a
added PowerShell setup Command
2020-10-10 13:03:34 -05:00
Tsquash
8d4e80c23a
Added Dfu-Util to setup instructions
2020-10-10 11:10:17 -05:00
Kurtis Lew
fc6c01fd69
-DZMK_CONFIG Documentation ( #255 )
...
feat(docs): `-DZMK_CONFIG` Documentation
2020-10-09 23:56:52 -04:00