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

Some basic docs clean up.

Browse source
This commit is contained in:
Pete Johanson 2020-05-31 15:35:32 -04:00
parent 749df61a2e
commit f1afbb8e49
2 changed files with 68 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
docs/docusaurus.config.js
View file

@ -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: [

92
docs/src/pages/index.js
View file

@ -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>