Merge pull request #290 from innovaker/docusaurus-2.0.0-alpha.65
chore(docs): Docusaurus 2.0.0 alpha.65
This commit is contained in:
commit
d8740b91ab
6 changed files with 4299 additions and 3738 deletions
|
@ -1,5 +1,4 @@
|
|||
---
|
||||
id: wip
|
||||
title: WIP
|
||||
author: Pete Johanson
|
||||
author_title: Project Creator
|
||||
|
|
|
@ -13,7 +13,7 @@ The high level steps are:
|
|||
|
||||
- Create a new shield directory.
|
||||
- Add the base Kconfig files.
|
||||
- Add the shield overlay file to define the [KSCAN driver]() for detecting key press/release.
|
||||
- Add the shield overlay file to define the KSCAN driver for detecting key press/release.
|
||||
- (Optional) Add the matrix transform for mapping KSCAN row/column values to sane key positions. This is needed for non-rectangular keyboards, or where the underlying row/column pin arrangement does not map one to one with logical locations on the keyboard.
|
||||
- Add a default keymap, which users can override in their own configs as needed.
|
||||
- Add support for features such as encoders, OLED displays, or RGB underglow.
|
||||
|
@ -112,7 +112,7 @@ values={[
|
|||
|
||||
<TabItem value="unibody">
|
||||
|
||||
The `<shield_name>.overlay` is the devicetree description of the keyboard shield that is merged with the primary board devicetree description before the build. For ZMK, this file at a minimum should include the [chosen]() node named `zmk,kscan` that references a KSCAN driver instance. For a simple 3x3 macropad matrix,
|
||||
The `<shield_name>.overlay` is the devicetree description of the keyboard shield that is merged with the primary board devicetree description before the build. For ZMK, this file at a minimum should include the chosen node named `zmk,kscan` that references a KSCAN driver instance. For a simple 3x3 macropad matrix,
|
||||
this might look something like:
|
||||
|
||||
```
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
id: intro
|
||||
title: Introduction to ZMK
|
||||
sidebar_label: Introduction
|
||||
slug: /
|
||||
---
|
||||
|
||||
ZMK Firmware is an open source (MIT) keyboard
|
||||
|
|
|
@ -102,7 +102,6 @@ module.exports = {
|
|||
{
|
||||
docs: {
|
||||
// It is recommended to set document id as docs home page (`docs/` path).
|
||||
homePageId: "intro",
|
||||
sidebarPath: require.resolve("./sidebars.js"),
|
||||
// Please change this to your repo.
|
||||
editUrl: "https://github.com/zmkfirmware/zmk/edit/main/docs/",
|
||||
|
|
8018
docs/package-lock.json
generated
8018
docs/package-lock.json
generated
File diff suppressed because it is too large
Load diff
|
@ -9,8 +9,8 @@
|
|||
"deploy": "docusaurus deploy"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "^2.0.0-alpha.61",
|
||||
"@docusaurus/preset-classic": "^2.0.0-alpha.61",
|
||||
"@docusaurus/core": "^2.0.0-alpha.65",
|
||||
"@docusaurus/preset-classic": "^2.0.0-alpha.65",
|
||||
"classnames": "^2.2.6",
|
||||
"react": "^16.8.4",
|
||||
"react-dom": "^16.8.4"
|
||||
|
|
Loading…
Reference in a new issue