From 8812f4bc9b51d3379435c1d5a9587de86248da52 Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Wed, 18 May 2022 14:22:38 -0700 Subject: [PATCH] Customize options for Corso (#48) Uses a Noun project icon for now. Color #776A60 used with https://thenounproject.com/icon/cane-corso-4559376/ Co-authored-by: Vaibhav Kamra --- docs/docusaurus.config.js | 29 +++++++++++++---------------- docs/src/pages/index.js | 6 +++--- docs/static/img/corso.svg | 15 +++++++++++++++ 3 files changed, 31 insertions(+), 19 deletions(-) create mode 100644 docs/static/img/corso.svg diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 7a8a109a2..1cdb1f38e 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -6,18 +6,18 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'My Site', - tagline: 'Dinosaurs are cool', - url: 'https://your-docusaurus-test-site.com', + title: 'Corso Documentation', + tagline: 'Because Backups Are Cool', + url: 'https://corsobackup.io', baseUrl: '/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', - favicon: 'img/favicon.ico', + favicon: 'img/corso.svg', // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. - organizationName: 'facebook', // Usually your GitHub org/user name. - projectName: 'docusaurus', // Usually your repo name. + organizationName: 'alcionai', // Usually your GitHub org/user name. + projectName: 'corso', // Usually your repo name. // Even if you don't use internalization, you can use this field to set useful // metadata like html lang. For example, if your site is Chinese, you may want @@ -32,7 +32,8 @@ const config = { 'classic', /** @type {import('@docusaurus/preset-classic').Options} */ ({ - docs: { + docs: { + routeBasePath: '/', sidebarPath: require.resolve('./sidebars.js'), // Please change this to your repo. // Remove this to remove the "edit this page" links. @@ -51,10 +52,10 @@ const config = { /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ navbar: { - title: 'My Site', + title: 'Corso', logo: { alt: 'My Site Logo', - src: 'img/logo.svg', + src: 'img/corso.svg', }, items: [ { @@ -85,17 +86,13 @@ const config = { { 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', + href: 'https://twitter.com/alcionhq', }, ], }, @@ -104,12 +101,12 @@ const config = { items: [ { label: 'GitHub', - href: 'https://github.com/facebook/docusaurus', + href: 'https://github.com/alcionai/corso', }, ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()}`, }, prism: { theme: lightCodeTheme, diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index a4fc2d3f0..4e869dd8d 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -16,7 +16,7 @@ function HomepageHeader() {
+ to="intro"> Docusaurus Tutorial - 5min ⏱️
@@ -29,8 +29,8 @@ export default function Home() { const {siteConfig} = useDocusaurusContext(); return ( + title={`${siteConfig.title}`} + description="Documentation for the Corso backup tool">
diff --git a/docs/static/img/corso.svg b/docs/static/img/corso.svg new file mode 100644 index 000000000..2505a6d71 --- /dev/null +++ b/docs/static/img/corso.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + +