mirror of
https://github.com/facebook/docusaurus.git
synced 2025-04-29 18:27:56 +02:00
docs: bidirectional link between api config and guide config (#8950)
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
This commit is contained in:
parent
2a96ec01de
commit
cf9fa2e78f
3 changed files with 13 additions and 2 deletions
|
@ -291,6 +291,7 @@ redwoodjs
|
|||
refactorings
|
||||
regexes
|
||||
rehype
|
||||
renderable
|
||||
reponame
|
||||
reqs
|
||||
requireindex
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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:
|
|||
|
||||
<TOCInline toc={toc} minHeadingLevel={3} maxHeadingLevel={3} />
|
||||
|
||||
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`.
|
||||
|
|
Loading…
Add table
Reference in a new issue