diff --git a/docusaurus-site/.gitignore b/docusaurus-site/.gitignore index b2d6de30624f651a6c584d4faefafceac6302be1..2d91311a5a02854361c84da14c428101519edb11 100644 --- a/docusaurus-site/.gitignore +++ b/docusaurus-site/.gitignore @@ -1,5 +1,7 @@ # Dependencies /node_modules +package-lock.json +yarn.lock # Production /build diff --git a/docusaurus-site/docs/quick-reference.md b/docusaurus-site/docs/quick-reference.md index 1870664c738eb8133afbb7e35fa767616d2c59c0..959e9f299ca5a84e798d070b04654127e8057987 100644 --- a/docusaurus-site/docs/quick-reference.md +++ b/docusaurus-site/docs/quick-reference.md @@ -7,7 +7,7 @@ sidebar_position: 3 This document provides brief descriptions of all public functions, types, and interfaces exposed by the Client API (xxDK). <!-- Each item links to a page with more detail. --> :::note -If you are new to the xxDK, you can start with the [Overview](./overview) and [Getting Started](./getting-started) docs. +If you are new to the xxDK, you can start with the [Overview](/) and [Getting Started](./getting-started) docs. ::: Note that if you're running the client locally, you can use `go doc` to explore the list of functions and interfaces. diff --git a/docusaurus-site/docusaurus.config.js b/docusaurus-site/docusaurus.config.js index 763c696d973fcbae2062b4ec88420b55cc1e5b78..269d35a8279dd17581dae0ae5ac8418e4e940da1 100644 --- a/docusaurus-site/docusaurus.config.js +++ b/docusaurus-site/docusaurus.config.js @@ -10,7 +10,7 @@ const config = { tagline: 'The frontend of the CMix protocol', url: 'https://xxdk-dev.xx.network', baseUrl: '/', - onBrokenLinks: 'warn', + onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', favicon: 'img/favicon.ico', organizationName: 'xxnetwork', // Usually your GitHub org/user name. @@ -27,12 +27,7 @@ const config = { // Please change this to your repo. editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/', }, - blog: { - showReadingTime: true, - // Please change this to your repo. - editUrl: - 'https://github.com/facebook/docusaurus/edit/main/website/blog/', - }, + blog: false, theme: { customCss: require.resolve('./src/css/custom.css'), }, @@ -56,7 +51,6 @@ const config = { position: 'left', label: 'Docs', }, - // {to: '/blog', label: 'Blog', position: 'left'}, { href: 'https://git.xx.network/elixxir/xxdk-dev-docs', label: 'GitHub', @@ -67,15 +61,6 @@ const config = { footer: { style: 'dark', links: [ - // { - // title: 'Docs', - // items: [ - // { - // label: 'Tutorial', - // to: '/docs/intro', - // }, - // ], - // }, { title: 'Community', items: [ @@ -96,10 +81,6 @@ const config = { { title: 'More', items: [ - //{ - // label: 'Blog', - // to: '/blog', - //}, { label: 'GitHub', href: 'https://github.com/facebook/docusaurus', @@ -107,7 +88,7 @@ const config = { ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} xx network. Built with Docusaurus.`, }, prism: { theme: lightCodeTheme,