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", title: "Docs",
items: [ items: [
{ {
label: "Style Guide", label: "Getting Started",
to: "docs/", to: "docs/",
}, },
{ {
label: "Second Doc", label: "Development",
to: "docs/doc2/", to: "docs/dev-setup/",
}, },
], ],
}, },
{ {
title: "Community", // title: "Community",
items: [ // items: [
{ // {
label: "Stack Overflow", // label: "Stack Overflow",
href: "https://stackoverflow.com/questions/tagged/docusaurus", // href: "https://stackoverflow.com/questions/tagged/docusaurus",
}, // },
{ // {
label: "Discord", // label: "Discord",
href: "https://discordapp.com/invite/docusaurus", // href: "https://discordapp.com/invite/docusaurus",
}, // },
{ // {
label: "Twitter", // label: "Twitter",
href: "https://twitter.com/docusaurus", // href: "https://twitter.com/docusaurus",
}, // },
], // ],
}, },
{ {
title: "More", title: "More",
@ -69,13 +69,13 @@ module.exports = {
to: "blog", to: "blog",
}, },
{ {
label: "GitHub", label: "GitLab",
href: "https://github.com/facebook/docusaurus", 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: [ presets: [

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

@ -1,48 +1,48 @@
import React from 'react'; import React from "react";
import classnames from 'classnames'; import classnames from "classnames";
import Layout from '@theme/Layout'; import Layout from "@theme/Layout";
import Link from '@docusaurus/Link'; import Link from "@docusaurus/Link";
import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
import useBaseUrl from '@docusaurus/useBaseUrl'; import useBaseUrl from "@docusaurus/useBaseUrl";
import styles from './styles.module.css'; import styles from "./styles.module.css";
const features = [ const features = [
{ // {
title: <>Easy to Use</>, // title: <>Easy to Use</>,
imageUrl: 'img/undraw_docusaurus_mountain.svg', // imageUrl: 'img/undraw_docusaurus_mountain.svg',
description: ( // description: (
<> // <>
Docusaurus was designed from the ground up to be easily installed and // Docusaurus was designed from the ground up to be easily installed and
used to get your website up and running quickly. // used to get your website up and running quickly.
</> // </>
), // ),
}, // },
{ // {
title: <>Focus on What Matters</>, // title: <>Focus on What Matters</>,
imageUrl: 'img/undraw_docusaurus_tree.svg', // imageUrl: 'img/undraw_docusaurus_tree.svg',
description: ( // description: (
<> // <>
Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go // 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. // ahead and move your docs into the <code>docs</code> directory.
</> // </>
), // ),
}, // },
{ // {
title: <>Powered by React</>, // title: <>Powered by React</>,
imageUrl: 'img/undraw_docusaurus_react.svg', // imageUrl: 'img/undraw_docusaurus_react.svg',
description: ( // description: (
<> // <>
Extend or customize your website layout by reusing React. Docusaurus can // Extend or customize your website layout by reusing React. Docusaurus can
be extended while reusing the same header and footer. // be extended while reusing the same header and footer.
</> // </>
), // ),
}, // },
]; ];
function Feature({imageUrl, title, description}) { function Feature({ imageUrl, title, description }) {
const imgUrl = useBaseUrl(imageUrl); const imgUrl = useBaseUrl(imageUrl);
return ( return (
<div className={classnames('col col--4', styles.feature)}> <div className={classnames("col col--4", styles.feature)}>
{imgUrl && ( {imgUrl && (
<div className="text--center"> <div className="text--center">
<img className={styles.featureImage} src={imgUrl} alt={title} /> <img className={styles.featureImage} src={imgUrl} alt={title} />
@ -56,22 +56,24 @@ function Feature({imageUrl, title, description}) {
function Home() { function Home() {
const context = useDocusaurusContext(); const context = useDocusaurusContext();
const {siteConfig = {}} = context; const { siteConfig = {} } = context;
return ( return (
<Layout <Layout
title={`Hello from ${siteConfig.title}`} title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />"> description="Description will go into a meta tag in <head />"
<header className={classnames('hero hero--primary', styles.heroBanner)}> >
<header className={classnames("hero hero--primary", styles.heroBanner)}>
<div className="container"> <div className="container">
<h1 className="hero__title">{siteConfig.title}</h1> <h1 className="hero__title">{siteConfig.title}</h1>
<p className="hero__subtitle">{siteConfig.tagline}</p> <p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}> <div className={styles.buttons}>
<Link <Link
className={classnames( className={classnames(
'button button--outline button--secondary button--lg', "button button--outline button--secondary button--lg",
styles.getStarted, styles.getStarted
)} )}
to={useBaseUrl('docs/')}> to={useBaseUrl("docs/")}
>
Get Started Get Started
</Link> </Link>
</div> </div>