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 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. diff --git a/website/docs/configuration.mdx b/website/docs/configuration.mdx index 734b6a21a8c6..2d0055c943a7 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,8 +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} Site metadata contains the essential global metadata such as `title`, `url`, `baseUrl`, and `favicon`.