steven-y-e
/
zmk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
zmk/docs/sidebars.js

62 lines
1.4 KiB
JavaScript
Raw Normal View History

Initial work on basic documentation.
2020-05-25 21:33:21 -04:00
module.exports = {
docs: Rename `someSidebar` to `docs`
2020-11-12 09:41:03 -05:00
docs: {
Add hold-tap to sidebar.
2020-09-03 10:14:16 -04:00
"Getting Started": [
"intro",
"hardware",
"faq",
"user-setup",
"customization",
docs: Format docs with prettier npx prettier --write .
2020-10-25 13:23:51 -04:00
"troubleshooting",
Add hold-tap to sidebar.
2020-09-03 10:14:16 -04:00
],
Docs re-org, start of some keymap docs.
2020-08-06 15:04:31 -04:00
Features: [
refactor(docs): Change `feature` to `features` Makes a better URL.
2020-11-11 16:24:19 -05:00
"features/keymaps",
refactor(docs): Move combos under Features. * Since combos aren't a behavior, but a new high level keymap feature, move under Features section.
2021-01-23 23:50:30 -05:00
"features/combos",
refactor(docs): Change `feature` to `features` Makes a better URL.
2020-11-11 16:24:19 -05:00
"features/displays",
"features/encoders",
"features/underglow",
Docs re-org, start of some keymap docs.
2020-08-06 15:04:31 -04:00
],
Add lighting behavior docs
2020-08-08 18:23:11 -04:00
Behaviors: [
refactor(docs): Change `behavior` to `behaviors` Makes a better URL.
2020-11-11 16:25:32 -05:00
"behaviors/key-press",
"behaviors/layers",
"behaviors/misc",
"behaviors/hold-tap",
"behaviors/mod-tap",
docs(sticky keys): document sticky keys and sticky layers
2020-12-13 08:33:28 -05:00
"behaviors/sticky-key",
"behaviors/sticky-layer",
refactor(docs): Change `behavior` to `behaviors` Makes a better URL.
2020-11-11 16:25:32 -05:00
"behaviors/reset",
"behaviors/bluetooth",
"behaviors/outputs",
"behaviors/lighting",
"behaviors/power",
Add lighting behavior docs
2020-08-08 18:23:11 -04:00
],
docs(codes): Add (key) codes documentation Create codes documentation for standardized keys. Closes #218. Fixes #308. Ref #21.
2020-11-06 14:42:54 -05:00
Codes: [
"codes/index",
"codes/keyboard-keypad",
docs(codes): add modifier functions Refactor and expand codes documentation to include modifier functions. Closes #330.
2020-11-06 15:34:36 -05:00
"codes/modifiers",
docs(codes): Add (key) codes documentation Create codes documentation for standardized keys. Closes #218. Fixes #308. Ref #21.
2020-11-06 14:42:54 -05:00
"codes/editing",
"codes/media",
"codes/applications",
"codes/input-assist",
"codes/power",
feat(docs): add keymap upgrader Added a documentation page with a script that upgrades deprecated key codes and behaviors to their replacements. Fixes #299
2020-11-07 19:03:20 -05:00
"codes/keymap-upgrader",
docs(codes): Add (key) codes documentation Create codes documentation for standardized keys. Closes #218. Fixes #308. Ref #21.
2020-11-06 14:42:54 -05:00
],
Expanded dev docs on boards/shields/keymaps.
2020-07-06 11:40:03 -04:00
Development: [
refactor(docs): Move `dev-` documents into `/development` Aligns to conventions introduced by newer documentation.
2020-11-12 07:18:45 -05:00
"development/clean-room",
feat(docs): add information on how to update the documentation to the docs
2020-11-27 17:04:15 -05:00
"development/documentation",
refactor(docs): Move `dev-` documents into `/development` Aligns to conventions introduced by newer documentation.
2020-11-12 07:18:45 -05:00
"development/setup",
"development/build-flash",
"development/boards-shields-keymaps",
"development/posix-board",
"development/tests",
refactor(docs): Integrate `USB Logging` into `Development` section Improves discoverability.
2020-11-12 08:33:25 -05:00
"development/usb-logging",
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.
2020-09-19 17:32:24 -04:00
"development/ide-integration",
refactor(docs): Integrate `Dev Guides` into `Development` section Improves discoverability.
2020-11-12 08:38:35 -05:00
{
type: "category",
label: "Guides",
collapsed: false,
items: ["development/new-shield"],
},
refactor(docs): Move `dev-` documents into `/development` Aligns to conventions introduced by newer documentation.
2020-11-12 07:18:45 -05:00
],
Initial work on basic documentation.
2020-05-25 21:33:21 -04:00
},
};