3975d2fdaf
* Document setting up studio for a new keyboard definition. * Document how to enable ZMK Studio for a build, adding reserved layers, and controlling which behaviors are built into a studio firmware. * Document `&studio_unlock` behavior. * Document studio configuration options. Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
173 lines
4.6 KiB
JavaScript
173 lines
4.6 KiB
JavaScript
module.exports = {
|
|
docs: [
|
|
{
|
|
type: "category",
|
|
label: "Getting Started",
|
|
link: {
|
|
type: "doc",
|
|
id: "intro",
|
|
},
|
|
collapsed: false,
|
|
items: [
|
|
"hardware",
|
|
"faq",
|
|
"user-setup",
|
|
"customization",
|
|
{
|
|
type: "category",
|
|
label: "Troubleshooting",
|
|
link: {
|
|
type: "doc",
|
|
id: "troubleshooting/index",
|
|
},
|
|
collapsed: true,
|
|
items: [
|
|
"troubleshooting/building-issues",
|
|
"troubleshooting/flashing-issues",
|
|
"troubleshooting/connection-issues",
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
Features: [
|
|
"features/bluetooth",
|
|
"features/modules",
|
|
"features/split-keyboards",
|
|
"features/debouncing",
|
|
"features/battery",
|
|
"features/soft-off",
|
|
"features/encoders",
|
|
"features/displays",
|
|
"features/backlight",
|
|
"features/underglow",
|
|
"features/studio",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Keymaps",
|
|
link: {
|
|
type: "doc",
|
|
id: "keymaps/index",
|
|
},
|
|
collapsed: true,
|
|
items: [
|
|
{
|
|
type: "category",
|
|
label: "Behaviors",
|
|
link: {
|
|
type: "doc",
|
|
id: "keymaps/behaviors/index",
|
|
},
|
|
collapsed: true,
|
|
items: [
|
|
"keymaps/behaviors/key-press",
|
|
"keymaps/behaviors/layers",
|
|
"keymaps/behaviors/misc",
|
|
"keymaps/behaviors/hold-tap",
|
|
"keymaps/behaviors/mod-tap",
|
|
"keymaps/behaviors/mod-morph",
|
|
"keymaps/behaviors/macros",
|
|
"keymaps/behaviors/key-toggle",
|
|
"keymaps/behaviors/sticky-key",
|
|
"keymaps/behaviors/sticky-layer",
|
|
"keymaps/behaviors/tap-dance",
|
|
"keymaps/behaviors/caps-word",
|
|
"keymaps/behaviors/key-repeat",
|
|
"keymaps/behaviors/sensor-rotate",
|
|
"keymaps/behaviors/mouse-emulation",
|
|
"keymaps/behaviors/reset",
|
|
"keymaps/behaviors/bluetooth",
|
|
"keymaps/behaviors/outputs",
|
|
"keymaps/behaviors/underglow",
|
|
"keymaps/behaviors/backlight",
|
|
"keymaps/behaviors/power",
|
|
"keymaps/behaviors/soft-off",
|
|
"keymaps/behaviors/studio-unlock",
|
|
],
|
|
},
|
|
"keymaps/modifiers",
|
|
"keymaps/combos",
|
|
"keymaps/conditional-layers",
|
|
"keymaps/list-of-keycodes",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Configuration",
|
|
link: {
|
|
type: "doc",
|
|
id: "config/index",
|
|
},
|
|
collapsed: true,
|
|
items: [
|
|
"config/backlight",
|
|
"config/battery",
|
|
"config/behaviors",
|
|
"config/bluetooth",
|
|
"config/combos",
|
|
"config/displays",
|
|
"config/encoders",
|
|
"config/keymap",
|
|
"config/kscan",
|
|
"config/power",
|
|
"config/underglow",
|
|
"config/system",
|
|
"config/studio",
|
|
],
|
|
},
|
|
{
|
|
Development: [
|
|
{
|
|
type: "category",
|
|
label: "Hardware Integration",
|
|
collapsed: true,
|
|
items: [
|
|
"development/hardware-integration/new-shield",
|
|
"development/hardware-integration/hardware-metadata-files",
|
|
"development/hardware-integration/boards-shields-keymaps",
|
|
"development/hardware-integration/studio-setup",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Contributing",
|
|
collapsed: true,
|
|
items: [
|
|
"development/contributing/clean-room",
|
|
"development/contributing/documentation",
|
|
],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "Local Toolchain",
|
|
collapsed: true,
|
|
items: [
|
|
{
|
|
type: "category",
|
|
label: "Setup",
|
|
link: {
|
|
type: "doc",
|
|
id: "development/local-toolchain/setup/index",
|
|
},
|
|
collapsed: true,
|
|
items: [
|
|
"development/local-toolchain/setup/docker",
|
|
"development/local-toolchain/setup/native",
|
|
],
|
|
},
|
|
"development/local-toolchain/build-flash",
|
|
"development/local-toolchain/pre-commit",
|
|
"development/local-toolchain/ide-integration",
|
|
"development/local-toolchain/tests",
|
|
"development/local-toolchain/posix-board",
|
|
],
|
|
},
|
|
"development/usb-logging",
|
|
"development/studio-rpc-protocol",
|
|
"development/new-behavior",
|
|
],
|
|
},
|
|
],
|
|
};
|