From f1afbb8e49383d429096bc84fc5855c3929acc50 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Sun, 31 May 2020 15:35:32 -0400 Subject: [PATCH] Some basic docs clean up. --- docs/docusaurus.config.js | 42 +++++++++--------- docs/src/pages/index.js | 92 ++++++++++++++++++++------------------- 2 files changed, 68 insertions(+), 66 deletions(-) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 3e92198f..ef6863bc 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 f24bc962..ca209fc9 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'll do the chores. Go - ahead and move your docs into the docs 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'll do the chores. Go + // ahead and move your docs into the docs 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 ( -
+
{imgUrl && (
{title} @@ -56,22 +56,24 @@ function Feature({imageUrl, title, description}) { function Home() { const context = useDocusaurusContext(); - const {siteConfig = {}} = context; + const { siteConfig = {} } = context; return ( -
+ description="Description will go into a meta tag in " + > +

{siteConfig.title}

{siteConfig.tagline}

+ to={useBaseUrl("docs/")} + > Get Started