summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPete Johanson <peter@peterjohanson.com>2020-05-31 15:35:32 -0400
committerPete Johanson <peter@peterjohanson.com>2020-05-31 15:35:32 -0400
commitf1afbb8e49383d429096bc84fc5855c3929acc50 (patch)
tree9cd96f15f06060029b216f226a3228b9c7ed270e
parent749df61a2e1ebf3983f4c31140841fa6556d63b9 (diff)
Some basic docs clean up.
-rw-r--r--docs/docusaurus.config.js42
-rw-r--r--docs/src/pages/index.js92
2 files changed, 68 insertions, 66 deletions
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index 3e92198..ef6863b 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -35,31 +35,31 @@ module.exports = {
title: "Docs",
items: [
{
- label: "Style Guide",
+ label: "Getting Started",
to: "docs/",
},
{
- label: "Second Doc",
- to: "docs/doc2/",
+ label: "Development",
+ to: "docs/dev-setup/",
},
],
},
{
- title: "Community",
- items: [
- {
- label: "Stack Overflow",
- href: "https://stackoverflow.com/questions/tagged/docusaurus",
- },
- {
- label: "Discord",
- href: "https://discordapp.com/invite/docusaurus",
- },
- {
- label: "Twitter",
- href: "https://twitter.com/docusaurus",
- },
- ],
+ // title: "Community",
+ // items: [
+ // {
+ // label: "Stack Overflow",
+ // href: "https://stackoverflow.com/questions/tagged/docusaurus",
+ // },
+ // {
+ // label: "Discord",
+ // href: "https://discordapp.com/invite/docusaurus",
+ // },
+ // {
+ // label: "Twitter",
+ // href: "https://twitter.com/docusaurus",
+ // },
+ // ],
},
{
title: "More",
@@ -69,13 +69,13 @@ module.exports = {
to: "blog",
},
{
- label: "GitHub",
- href: "https://github.com/facebook/docusaurus",
+ label: "GitLab",
+ href: "https://gitlab.com/zmkproject/zmk",
},
],
},
],
- copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
+ copyright: `Copyright © ${new Date().getFullYear()} ZMK Project Contributors, Built with Docusaurus.`,
},
},
presets: [
diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js
index f24bc96..ca209fc 100644
--- a/docs/src/pages/index.js
+++ b/docs/src/pages/index.js
@@ -1,48 +1,48 @@
-import React from 'react';
-import classnames from 'classnames';
-import Layout from '@theme/Layout';
-import Link from '@docusaurus/Link';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import useBaseUrl from '@docusaurus/useBaseUrl';
-import styles from './styles.module.css';
+import React from "react";
+import classnames from "classnames";
+import Layout from "@theme/Layout";
+import Link from "@docusaurus/Link";
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import styles from "./styles.module.css";
const features = [
- {
- title: <>Easy to Use</>,
- imageUrl: 'img/undraw_docusaurus_mountain.svg',
- description: (
- <>
- Docusaurus was designed from the ground up to be easily installed and
- used to get your website up and running quickly.
- </>
- ),
- },
- {
- title: <>Focus on What Matters</>,
- imageUrl: 'img/undraw_docusaurus_tree.svg',
- description: (
- <>
- Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
- ahead and move your docs into the <code>docs</code> directory.
- </>
- ),
- },
- {
- title: <>Powered by React</>,
- imageUrl: 'img/undraw_docusaurus_react.svg',
- description: (
- <>
- Extend or customize your website layout by reusing React. Docusaurus can
- be extended while reusing the same header and footer.
- </>
- ),
- },
+ // {
+ // title: <>Easy to Use</>,
+ // imageUrl: 'img/undraw_docusaurus_mountain.svg',
+ // description: (
+ // <>
+ // Docusaurus was designed from the ground up to be easily installed and
+ // used to get your website up and running quickly.
+ // </>
+ // ),
+ // },
+ // {
+ // title: <>Focus on What Matters</>,
+ // imageUrl: 'img/undraw_docusaurus_tree.svg',
+ // description: (
+ // <>
+ // Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
+ // ahead and move your docs into the <code>docs</code> directory.
+ // </>
+ // ),
+ // },
+ // {
+ // title: <>Powered by React</>,
+ // imageUrl: 'img/undraw_docusaurus_react.svg',
+ // description: (
+ // <>
+ // Extend or customize your website layout by reusing React. Docusaurus can
+ // be extended while reusing the same header and footer.
+ // </>
+ // ),
+ // },
];
-function Feature({imageUrl, title, description}) {
+function Feature({ imageUrl, title, description }) {
const imgUrl = useBaseUrl(imageUrl);
return (
- <div className={classnames('col col--4', styles.feature)}>
+ <div className={classnames("col col--4", styles.feature)}>
{imgUrl && (
<div className="text--center">
<img className={styles.featureImage} src={imgUrl} alt={title} />
@@ -56,22 +56,24 @@ function Feature({imageUrl, title, description}) {
function Home() {
const context = useDocusaurusContext();
- const {siteConfig = {}} = context;
+ const { siteConfig = {} } = context;
return (
<Layout
title={`Hello from ${siteConfig.title}`}
- description="Description will go into a meta tag in <head />">
- <header className={classnames('hero hero--primary', styles.heroBanner)}>
+ description="Description will go into a meta tag in <head />"
+ >
+ <header className={classnames("hero hero--primary", styles.heroBanner)}>
<div className="container">
<h1 className="hero__title">{siteConfig.title}</h1>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link
className={classnames(
- 'button button--outline button--secondary button--lg',
- styles.getStarted,
+ "button button--outline button--secondary button--lg",
+ styles.getStarted
)}
- to={useBaseUrl('docs/')}>
+ to={useBaseUrl("docs/")}
+ >
Get Started
</Link>
</div>