From c5a414e241bd94f61553820c98daefb18e307efe Mon Sep 17 00:00:00 2001 From: jemimah2 <jemimah@elixxir.io> Date: Fri, 17 Dec 2021 10:42:05 +0100 Subject: [PATCH] Enable Docusaurus' docs-only mode --- docusaurus-site/docs/getting-started.md | 1 + docusaurus-site/docusaurus.config.js | 1 + docusaurus-site/src/pages/index.js | 40 ---------------------- docusaurus-site/src/pages/index.module.css | 23 ------------- docusaurus-site/src/pages/markdown-page.md | 7 ---- 5 files changed, 2 insertions(+), 70 deletions(-) delete mode 100644 docusaurus-site/src/pages/index.js delete mode 100644 docusaurus-site/src/pages/index.module.css delete mode 100644 docusaurus-site/src/pages/markdown-page.md diff --git a/docusaurus-site/docs/getting-started.md b/docusaurus-site/docs/getting-started.md index 027d8a6..6ba6f02 100644 --- a/docusaurus-site/docs/getting-started.md +++ b/docusaurus-site/docs/getting-started.md @@ -1,4 +1,5 @@ --- +slug: / sidebar_position: 2 --- diff --git a/docusaurus-site/docusaurus.config.js b/docusaurus-site/docusaurus.config.js index de36ae1..bc08b6a 100644 --- a/docusaurus-site/docusaurus.config.js +++ b/docusaurus-site/docusaurus.config.js @@ -23,6 +23,7 @@ const config = { ({ docs: { sidebarPath: require.resolve('./sidebars.js'), + routeBasePath: '/', // Please change this to your repo. editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/', }, diff --git a/docusaurus-site/src/pages/index.js b/docusaurus-site/src/pages/index.js deleted file mode 100644 index 27c21e8..0000000 --- a/docusaurus-site/src/pages/index.js +++ /dev/null @@ -1,40 +0,0 @@ -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="button button--secondary button--lg" - to="/docs/intro"> - Docusaurus Tutorial - 5min â±ï¸ - </Link> - </div> - </div> - </header> - ); -} - -export default function Home() { - const {siteConfig} = useDocusaurusContext(); - return ( - <Layout - title={`Hello from ${siteConfig.title}`} - description="Description will go into a meta tag in <head />"> - <HomepageHeader /> - <main> - <HomepageFeatures /> - </main> - </Layout> - ); -} diff --git a/docusaurus-site/src/pages/index.module.css b/docusaurus-site/src/pages/index.module.css deleted file mode 100644 index 666feb6..0000000 --- a/docusaurus-site/src/pages/index.module.css +++ /dev/null @@ -1,23 +0,0 @@ -/** - * 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; -} diff --git a/docusaurus-site/src/pages/markdown-page.md b/docusaurus-site/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b..0000000 --- a/docusaurus-site/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. -- GitLab