summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/components/HomepageFeatures.module.css11
-rw-r--r--docs/src/components/HomepageFeatures.tsx76
-rw-r--r--docs/src/css/custom.css29
-rw-r--r--docs/src/pages/index.module.css28
-rw-r--r--docs/src/pages/index.tsx45
5 files changed, 189 insertions, 0 deletions
diff --git a/docs/src/components/HomepageFeatures.module.css b/docs/src/components/HomepageFeatures.module.css
new file mode 100644
index 0000000..b248eb2
--- /dev/null
+++ b/docs/src/components/HomepageFeatures.module.css
@@ -0,0 +1,11 @@
+.features {
+ display: flex;
+ align-items: center;
+ padding: 2rem 0;
+ width: 100%;
+}
+
+.featureSvg {
+ height: 200px;
+ width: 200px;
+}
diff --git a/docs/src/components/HomepageFeatures.tsx b/docs/src/components/HomepageFeatures.tsx
new file mode 100644
index 0000000..3897078
--- /dev/null
+++ b/docs/src/components/HomepageFeatures.tsx
@@ -0,0 +1,76 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import clsx from 'clsx';
+import styles from './HomepageFeatures.module.css';
+
+type FeatureItem = {
+ title: string;
+ image: string;
+ description: JSX.Element;
+};
+
+const FeatureList: FeatureItem[] = [
+ {
+ title: 'Easy to Use',
+ image: '/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',
+ image: '/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',
+ image: '/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({title, image, description}: FeatureItem) {
+ return (
+ <div className={clsx('col col--4')}>
+ <div className="text--center">
+ <img className={styles.featureSvg} alt={title} src={image} />
+ </div>
+ <div className="text--center padding-horiz--md">
+ <h3>{title}</h3>
+ <p>{description}</p>
+ </div>
+ </div>
+ );
+}
+
+export default function HomepageFeatures(): JSX.Element {
+ return (
+ <section className={styles.features}>
+ <div className="container">
+ <div className="row">
+ {FeatureList.map((props, idx) => (
+ <Feature key={idx} {...props} />
+ ))}
+ </div>
+ </div>
+ </section>
+ );
+}
diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css
new file mode 100644
index 0000000..3f618b3
--- /dev/null
+++ b/docs/src/css/custom.css
@@ -0,0 +1,29 @@
+/**
+ * Any CSS included here will be global. The classic template
+ * bundles Infima by default. Infima is a CSS framework designed to
+ * work well for content-centric websites.
+ */
+
+/* You can override the default Infima variables here. */
+
+:root {
+ --ifm-color-primary: #FAB770;
+ --ifm-color-primary-dark: rgb(33, 175, 144);
+ --ifm-color-primary-darker: rgb(31, 165, 136);
+ --ifm-color-primary-darkest: rgb(26, 136, 112);
+ --ifm-color-primary-light: rgb(70, 203, 174);
+ --ifm-color-primary-lighter: rgb(102, 212, 189);
+ --ifm-color-primary-lightest: rgb(146, 224, 208);
+ --ifm-code-font-size: 95%;
+}
+
+.docusaurus-highlight-code-line {
+ background-color: rgba(0, 0, 0, 0.1);
+ display: block;
+ margin: 0 calc(-1 * var(--ifm-pre-padding));
+ padding: 0 var(--ifm-pre-padding);
+}
+
+html[data-theme='dark'] .docusaurus-highlight-code-line {
+ background-color: rgba(0, 0, 0, 0.3);
+}
diff --git a/docs/src/pages/index.module.css b/docs/src/pages/index.module.css
new file mode 100644
index 0000000..e6f1476
--- /dev/null
+++ b/docs/src/pages/index.module.css
@@ -0,0 +1,28 @@
+/**
+ * CSS files with the .module.css suffix will be treated as CSS modules
+ * and scoped locally.
+ */
+
+.heroBanner {
+ padding: 4rem 0;
+ text-align: center;
+ position: relative;
+ overflow: hidden;
+}
+
+@media screen and (max-width: 966px) {
+ .heroBanner {
+ padding: 2rem;
+ }
+}
+
+.buttons {
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ flex-wrap: wrap;
+}
+
+.button {
+ margin: 3px;
+} \ No newline at end of file
diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx
new file mode 100644
index 0000000..da7f6ea
--- /dev/null
+++ b/docs/src/pages/index.tsx
@@ -0,0 +1,45 @@
+import React from 'react';
+import clsx from 'clsx';
+import Layout from '@theme/Layout';
+import Link from '@docusaurus/Link';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import styles from './index.module.css';
+import HomepageFeatures from '../components/HomepageFeatures';
+
+function HomepageHeader() {
+ const {siteConfig} = useDocusaurusContext();
+ return (
+ <header className={clsx('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={clsx("button button--secondary button--lg", styles.button)}
+ to="/docs/quickstart">
+ Docusaurus Tutorial - 5min ⏱️
+ </Link>
+ <Link
+ className={clsx("button button--secondary button--lg", styles.button)}
+ to="/docs/intro">
+ User Guide
+ </Link>
+ </div>
+ </div>
+ </header>
+ );
+}
+
+export default function Home(): JSX.Element {
+ const { siteConfig } = useDocusaurusContext();
+ return (
+ <Layout
+ title={siteConfig.tagline}
+ description={siteConfig.tagline}>
+ <HomepageHeader />
+ <main>
+ <HomepageFeatures />
+ </main>
+ </Layout>
+ );
+}