From d60137a01973d38a919692c726770f9185bf0886 Mon Sep 17 00:00:00 2001
From: jakub <jakub@elixxir.io>
Date: Tue, 22 Feb 2022 23:38:35 +0100
Subject: [PATCH] Cleanup config, fix path
---
docusaurus-site/.gitignore | 2 ++
docusaurus-site/docs/quick-reference.md | 2 +-
docusaurus-site/docusaurus.config.js | 25 +++----------------------
3 files changed, 6 insertions(+), 23 deletions(-)
diff --git a/docusaurus-site/.gitignore b/docusaurus-site/.gitignore
index b2d6de3..2d91311 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 1870664..959e9f2 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 763c696..269d35a 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,
--
GitLab