Skip to content

Commit 05b448a

Browse files
NicellNicell
committed
init commit
0 parents  commit 05b448a

35 files changed

+22312
-0
lines changed

‎.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*

‎README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

‎build-guides/corne-wireless/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Corne Wireless",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Build your Corne Wireless step by step"
7+
}
8+
}

‎build-guides/corne-wireless/batteries.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Batteries

‎build-guides/corne-wireless/case.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 7
3+
---
4+
5+
# Case

‎build-guides/corne-wireless/display-cover.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# Display Cover

‎build-guides/corne-wireless/firmware.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 9
3+
---
4+
5+
# Firmware

‎build-guides/corne-wireless/getting-started.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Introduction

‎build-guides/corne-wireless/keycaps.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 8
3+
---
4+
5+
# Keycaps

‎build-guides/corne-wireless/nice-nano.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# nice!nano

‎build-guides/corne-wireless/nice-view.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
# nice!view

‎build-guides/corne-wireless/switches.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# Switches

‎build-guides/intro.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
description: Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
3+
slug: /
4+
sidebar_position: 1
5+
---
6+
7+
# Introduction

‎docusaurus.config.js

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
// @ts-check
2+
// Note: type annotations allow type checking and IDEs autocompletion
3+
4+
const lightCodeTheme = require('prism-react-renderer/themes/github');
5+
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
6+
7+
/** @type {import('@docusaurus/types').Config} */
8+
const config = {
9+
title: "Typeractive.xyz Documentation",
10+
tagline: "Documentation for Typeractive.xyz Products",
11+
favicon: "img/favicon.ico",
12+
13+
// Set the production url of your site here
14+
url: "https://docs.typeractive.xyz",
15+
// Set the /<baseUrl>/ pathname under which your site is served
16+
// For GitHub pages deployment, it is often '/<projectName>/'
17+
baseUrl: "/",
18+
19+
onBrokenLinks: "throw",
20+
onBrokenMarkdownLinks: "warn",
21+
22+
// Even if you don't use internalization, you can use this field to set useful
23+
// metadata like html lang. For example, if your site is Chinese, you may want
24+
// to replace "en" with "zh-Hans".
25+
i18n: {
26+
defaultLocale: "en",
27+
locales: ["en"],
28+
},
29+
30+
presets: [
31+
[
32+
"classic",
33+
/** @type {import('@docusaurus/preset-classic').Options} */
34+
({
35+
docs: {
36+
path: "products",
37+
routeBasePath: "products",
38+
sidebarPath: require.resolve("./sidebars.js"),
39+
// Please change this to your repo.
40+
// Remove this to remove the "edit this page" links.
41+
editUrl: "https://github.com/typeractivexyz/documentation/tree/main",
42+
},
43+
theme: {
44+
customCss: require.resolve("./src/css/custom.css"),
45+
},
46+
}),
47+
],
48+
],
49+
50+
plugins: [
51+
[
52+
"@docusaurus/plugin-content-docs",
53+
{
54+
id: "build-guides",
55+
path: "build-guides",
56+
routeBasePath: "build-guides",
57+
sidebarPath: require.resolve("./sidebars.js"),
58+
editUrl: "https://github.com/typeractivexyz/documentation/tree/main",
59+
},
60+
],
61+
[
62+
"@docusaurus/plugin-content-docs",
63+
{
64+
id: "troubleshooting",
65+
path: "troubleshooting",
66+
routeBasePath: "troubleshooting",
67+
sidebarPath: require.resolve("./sidebars.js"),
68+
editUrl: "https://github.com/typeractivexyz/documentation/tree/main",
69+
},
70+
],
71+
],
72+
73+
themeConfig:
74+
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
75+
({
76+
// Replace with your project's social card
77+
image: "img/docusaurus-social-card.jpg",
78+
navbar: {
79+
title: "My Site",
80+
logo: {
81+
alt: "My Site Logo",
82+
src: "img/logo.svg",
83+
},
84+
items: [
85+
{
86+
type: "doc",
87+
docId: "intro",
88+
position: "left",
89+
label: "Products",
90+
},
91+
{
92+
to: "build-guides",
93+
position: "left",
94+
label: "Build Guides",
95+
activeBaseRegex: `/build-guides/`,
96+
},
97+
{
98+
to: "troubleshooting",
99+
position: "left",
100+
label: "Troubleshooting",
101+
activeBaseRegex: `/troubleshooting/`,
102+
},
103+
{
104+
href: "https://typeractive.xyz",
105+
label: "Shop",
106+
position: "right",
107+
},
108+
{
109+
href: "https://typeractive.xyz/discord",
110+
label: "Discord",
111+
position: "right",
112+
},
113+
],
114+
},
115+
footer: {
116+
style: "dark",
117+
links: [
118+
{
119+
title: "Docs",
120+
items: [
121+
{
122+
label: "Tutorial",
123+
to: "/docs/intro",
124+
},
125+
],
126+
},
127+
{
128+
title: "Community",
129+
items: [
130+
{
131+
label: "Stack Overflow",
132+
href: "https://stackoverflow.com/questions/tagged/docusaurus",
133+
},
134+
{
135+
label: "Discord",
136+
href: "https://discordapp.com/invite/docusaurus",
137+
},
138+
{
139+
label: "Twitter",
140+
href: "https://twitter.com/docusaurus",
141+
},
142+
],
143+
},
144+
{
145+
title: "More",
146+
items: [
147+
{
148+
label: "Blog",
149+
to: "/blog",
150+
},
151+
{
152+
label: "GitHub",
153+
href: "https://github.com/facebook/docusaurus",
154+
},
155+
],
156+
},
157+
],
158+
copyright: `Copyright © ${new Date().getFullYear()} Nice Technologies LLC. Built with Docusaurus.`,
159+
},
160+
prism: {
161+
theme: lightCodeTheme,
162+
darkTheme: darkCodeTheme,
163+
},
164+
colorMode: {
165+
defaultMode: "light",
166+
disableSwitch: false,
167+
respectPrefersColorScheme: true,
168+
},
169+
}),
170+
};
171+
172+
module.exports = config;

0 commit comments

Comments
 (0)