pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #290 from innovaker/docusaurus-2.0.0-alpha.65

Browse source 
chore(docs): Docusaurus 2.0.0 alpha.65
This commit is contained in:
Pete Johanson 2020-10-21 09:46:56 -04:00 committed by GitHub
commit d8740b91ab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 4299 additions and 3738 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/blog/2020-05-24-wip.md
View file

@ -1,5 +1,4 @@
--- ---
id: wip
title: WIP title: WIP
author: Pete Johanson author: Pete Johanson
author_title: Project Creator author_title: Project Creator

4
docs/docs/dev-guide-new-shield.md
View file

@ -13,7 +13,7 @@ The high level steps are:
- Create a new shield directory. - Create a new shield directory.
- Add the base Kconfig files. - 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. - (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 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. - Add support for features such as encoders, OLED displays, or RGB underglow.
@ -112,7 +112,7 @@ values={[
<TabItem value="unibody"> <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: this might look something like:
``` ```

1
docs/docs/intro.md
View file

@ -2,6 +2,7 @@
id: intro id: intro
title: Introduction to ZMK title: Introduction to ZMK
sidebar_label: Introduction sidebar_label: Introduction
slug: /
--- ---
ZMK Firmware is an open source (MIT) keyboard ZMK Firmware is an open source (MIT) keyboard

1
docs/docusaurus.config.js
View file

@ -102,7 +102,6 @@ module.exports = {
{ {
docs: { docs: {
// It is recommended to set document id as docs home page (`docs/` path). // It is recommended to set document id as docs home page (`docs/` path).
homePageId: "intro",
sidebarPath: require.resolve("./sidebars.js"), sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo. // Please change this to your repo.
editUrl: "https://github.com/zmkfirmware/zmk/edit/main/docs/", editUrl: "https://github.com/zmkfirmware/zmk/edit/main/docs/",

8018
docs/package-lock.json generated
View file

File diff suppressed because it is too large Load diff

4
docs/package.json
View file

@ -9,8 +9,8 @@
"deploy": "docusaurus deploy" "deploy": "docusaurus deploy"
}, },
"dependencies": { "dependencies": {
"@docusaurus/core": "^2.0.0-alpha.61", "@docusaurus/core": "^2.0.0-alpha.65",
"@docusaurus/preset-classic": "^2.0.0-alpha.61", "@docusaurus/preset-classic": "^2.0.0-alpha.65",
"classnames": "^2.2.6", "classnames": "^2.2.6",
"react": "^16.8.4", "react": "^16.8.4",
"react-dom": "^16.8.4" "react-dom": "^16.8.4"