From 5df63998bba3124fe5514f012b3d55b588a0b6fc Mon Sep 17 00:00:00 2001 From: Thad Guidry Date: Sat, 29 Apr 2023 13:18:33 +0800 Subject: [PATCH 1/4] link Configuration and API to each other at top --- website/docs/api/docusaurus.config.js.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/website/docs/api/docusaurus.config.js.mdx b/website/docs/api/docusaurus.config.js.mdx index 9b4ff8762820..9b48ecd33128 100644 --- a/website/docs/api/docusaurus.config.js.mdx +++ b/website/docs/api/docusaurus.config.js.mdx @@ -6,6 +6,12 @@ slug: /api/docusaurus-config # `docusaurus.config.js` +:::info + +Refer to the Getting Started [**Configuration**](docs/configuration.mdx) for examples. + +::: + ## Overview {#overview} `docusaurus.config.js` contains configurations for your site and is placed in the root directory of your site. From f11c40794adab01f7e3109fa28b9a296b3ac52a6 Mon Sep 17 00:00:00 2001 From: Thad Guidry Date: Sat, 29 Apr 2023 13:18:50 +0800 Subject: [PATCH 2/4] Link Configuration to API --- website/docs/configuration.mdx | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/website/docs/configuration.mdx b/website/docs/configuration.mdx index 734b6a21a8c6..30b301a737d8 100644 --- a/website/docs/configuration.mdx +++ b/website/docs/configuration.mdx @@ -6,6 +6,12 @@ description: Configuring your site's behavior through docusaurus.config.js and m import TOCInline from '@theme/TOCInline'; +:::info + +Check the [**`docusaurus.config.js` API reference**](api/docusaurus.config.js.mdx) for an exhaustive list of options. + +::: + Docusaurus has a unique take on configurations. We encourage you to congregate information about your site into one place. We guard the fields of this file and facilitate making this data object accessible across your site. Keeping a well-maintained `docusaurus.config.js` helps you, your collaborators, and your open source contributors to be able to focus on documentation while still being able to customize the site. @@ -20,7 +26,6 @@ The high-level overview of Docusaurus configuration can be categorized into: -For exact reference to each of the configurable fields, you may refer to [**`docusaurus.config.js` API reference**](api/docusaurus.config.js.mdx). ### Site metadata {#site-metadata} From ff45864cd1d36ab4b6fe50e79f8bac55402c1c84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Wed, 3 May 2023 18:41:44 +0200 Subject: [PATCH 3/4] Update website/docs/configuration.mdx --- website/docs/configuration.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/configuration.mdx b/website/docs/configuration.mdx index 30b301a737d8..2d0055c943a7 100644 --- a/website/docs/configuration.mdx +++ b/website/docs/configuration.mdx @@ -26,7 +26,6 @@ The high-level overview of Docusaurus configuration can be categorized into: - ### Site metadata {#site-metadata} Site metadata contains the essential global metadata such as `title`, `url`, `baseUrl`, and `favicon`. From 3a0fb28ca74fd7e5fc121b6bf21c3687c066022a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Wed, 3 May 2023 18:48:58 +0200 Subject: [PATCH 4/4] Update project-words.txt --- project-words.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/project-words.txt b/project-words.txt index 58e3a6b7ff1d..0494a3c0575b 100644 --- a/project-words.txt +++ b/project-words.txt @@ -291,6 +291,7 @@ redwoodjs refactorings regexes rehype +renderable reponame reqs requireindex