Skip to content

Commit e00408d

Browse files
petejohansonpetejohanson
committed
Initial work on basic documentation.
1 parent 96b87b2 commit e00408d

19 files changed

+13924
-0
lines changed

‎docs/.gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎docs/README.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ npm ci
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ npm start
15+
```
16+
17+
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ npm build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+

‎docs/blog/2020-05-24-wip.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
id: wip
3+
title: WIP
4+
author: Pete Johanson
5+
author_title: Project Creator
6+
author_url: https://gitlab.com/petejohanson
7+
author_image_url: https://www.gravatar.com/avatar/2001ceff7e9dc753cf96fcb2e6f41110
8+
tags: [keyboards, firmeware, oss, bluetooth]
9+
---
10+
11+
This blog is a work-in-progress as I work on basic docs + blog on this nascent keyboard firmware.
12+
13+
As is, there are more features _missing_ from ZMK than features it has. As always with pre-alpha software,
14+
if something breaks, you get to keep both halves! (especially if it is a split KB)

‎docs/docs/dev-posix-board.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
id: dev-posix-board
3+
title: Native Posix board target
4+
---
5+
6+
In order to iterate quickly on firmware features, it can
7+
be helpful to build and run the firmware on your local
8+
workstation, with generated virtual press/release events
9+
flowing into the handler functions.
10+
11+
To do this, you can build ZMK targetting the
12+
`native_posix` board.
13+
14+
```
15+
west build --pristine --board native_posix
16+
```
17+
18+
Once built, you can run the firmware locally:
19+
20+
```
21+
./build/zephyr/zephyr.exe
22+
```
23+
24+
## Virtual Key Events
25+
26+
The virtual key presses are hardcoded in `boards/native_posix.overlay` file. should you want to change the sequence to test various actions like Mod-Tap, etc.

‎docs/docs/dev-setup.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
id: dev-setup
3+
title: Basic Setup
4+
sidebar_label: Basic Setup
5+
---
6+
7+
1. Install `west` from pip.
8+
1. Install the ARM SDK from Zephyr project.
9+
1. (Optional) Install 32-bit libs for building and testing locally.
10+
1. `west init -l zmk`
11+
1. Build it.
12+
1. Flash it.

‎docs/docs/hardware.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
id: hardware
3+
title: Supported Hardware
4+
sidebar_label: Supported Hardware
5+
---
6+
7+
:::warning
8+
9+
ZMK Firmware is still _completely_ untested on real KB hardware. It is pre-pre-pre-alpha quality.
10+
11+
:::
12+
13+
Current development of ZMK is focused on ARM, in particular stm32, MCUs, including the stm32wb for bluetooth support.

‎docs/docs/intro.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
id: intro
3+
title: Introduction to ZMK
4+
sidebar_label: Introduction
5+
---
6+
7+
ZMK Firmware is an open source (Apache 2.0) keyboard
8+
firmware built on the [Zephyr Project](https://zephyrproject.com/) RTOS.
9+
10+

‎docs/docusaurus.config.js

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
module.exports = {
2+
title: "ZMK Keyboard Firmware",
3+
tagline: "Modern, open source keyboard firmware ",
4+
url: "https://your-docusaurus-test-site.com",
5+
baseUrl: "/",
6+
favicon: "img/favicon.ico",
7+
organizationName: "zmkproject", // Usually your GitHub org/user name.
8+
projectName: "zmk", // Usually your repo name.
9+
themeConfig: {
10+
navbar: {
11+
title: "ZMK",
12+
logo: {
13+
alt: "ZMK Logo",
14+
src: "img/logo.svg",
15+
},
16+
links: [
17+
{
18+
to: "docs/",
19+
activeBasePath: "docs",
20+
label: "Docs",
21+
position: "left",
22+
},
23+
{ to: "blog", label: "Blog", position: "left" },
24+
{
25+
href: "https://gitlab.com/zmkproject/zmk",
26+
label: "GitLab",
27+
position: "right",
28+
},
29+
],
30+
},
31+
footer: {
32+
style: "dark",
33+
links: [
34+
{
35+
title: "Docs",
36+
items: [
37+
{
38+
label: "Style Guide",
39+
to: "docs/",
40+
},
41+
{
42+
label: "Second Doc",
43+
to: "docs/doc2/",
44+
},
45+
],
46+
},
47+
{
48+
title: "Community",
49+
items: [
50+
{
51+
label: "Stack Overflow",
52+
href: "https://stackoverflow.com/questions/tagged/docusaurus",
53+
},
54+
{
55+
label: "Discord",
56+
href: "https://discordapp.com/invite/docusaurus",
57+
},
58+
{
59+
label: "Twitter",
60+
href: "https://twitter.com/docusaurus",
61+
},
62+
],
63+
},
64+
{
65+
title: "More",
66+
items: [
67+
{
68+
label: "Blog",
69+
to: "blog",
70+
},
71+
{
72+
label: "GitHub",
73+
href: "https://github.com/facebook/docusaurus",
74+
},
75+
],
76+
},
77+
],
78+
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
79+
},
80+
},
81+
presets: [
82+
[
83+
"@docusaurus/preset-classic",
84+
{
85+
docs: {
86+
// It is recommended to set document id as docs home page (`docs/` path).
87+
homePageId: "intro",
88+
sidebarPath: require.resolve("./sidebars.js"),
89+
// Please change this to your repo.
90+
editUrl: "https://githlab.com/zmkproject/zmk/edit/master/docs/",
91+
},
92+
blog: {
93+
showReadingTime: true,
94+
// Please change this to your repo.
95+
editUrl: "https://gitlab.com/zmkproject/zmk/edit/master/docs/blog/",
96+
},
97+
theme: {
98+
customCss: require.resolve("./src/css/custom.css"),
99+
},
100+
},
101+
],
102+
],
103+
};

0 commit comments

Comments
 (0)