mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-04 01:09:20 +02:00
docs(v2): remove links to other page that looks like partial toc (#1579)
This commit is contained in:
parent
1fecdb7d02
commit
96c048b040
1 changed files with 5 additions and 21 deletions
|
@ -24,16 +24,14 @@ The configurations can be categorized into:
|
|||
- [Theme configurations, plugins, and presets](#theme-plugins-and-presets-configurations)
|
||||
- [Custom configurations](#custom-configurations)
|
||||
|
||||
For more details on the API, check out [the API Reference on `docusaurus.config.js`](docusaurus.config.js)
|
||||
|
||||
### Site meta
|
||||
|
||||
Site meta contains the essential meta information such as titles and `favicon`.
|
||||
|
||||
They are used by your site app in a number of places such as your site's title and headings, browser tab icon, and SEO.
|
||||
|
||||
- [title](docusaurus.config.js.md#title)
|
||||
- [tagline](docusaurus.config.js.md#tagline)
|
||||
- [favicon](docusaurus.config.js.md#favicon)
|
||||
|
||||
### Deployment configurations
|
||||
|
||||
Deployment configurations are used when you deploy your site with Docusaurus' deploy command. The related fields are:
|
||||
|
@ -42,40 +40,28 @@ Deployment configurations are used when you deploy your site with Docusaurus' de
|
|||
|
||||
<!-- TODO: currently these fields are only used in GH Pages, what about other deployment services such as Netlify -->
|
||||
|
||||
- [url](docusaurus.config.js.md#url)
|
||||
- [baseUrl](docusaurus.config.js.md#baseurl)
|
||||
- [organizationName](docusaurus.config.js.md#organizationname)
|
||||
- [projectName](docusaurus.config.js.md#projectname)
|
||||
|
||||
You may also check the doc for [Deployment](deployment.md) for more information about the fields.
|
||||
|
||||
### Theme, plugins, and presets configurations
|
||||
|
||||
<!-- TODO: More explanation from these docs, respectively -->
|
||||
|
||||
- [themeConfig](docusaurus.config.js.md#themeconfig)
|
||||
- [presets](docusaurus.config.js.md#presets)
|
||||
- [plugins](docusaurus.config.js.md#plugins)
|
||||
|
||||
### Custom configurations
|
||||
|
||||
Docusaurus guards `docusaurus.config.js` from unknown fields. To add a custom field, define it on `customFields`
|
||||
|
||||
- [customFields](docusaurus.config.js.md#customfields)
|
||||
|
||||
Example:
|
||||
|
||||
```js
|
||||
// docusaurus.config.js
|
||||
module.exports = {
|
||||
customFields: {
|
||||
'image': '',
|
||||
'keywords': []
|
||||
}
|
||||
image: '',
|
||||
keywords: [],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
## Accessing configuration from your site
|
||||
|
||||
Your configuration object will be made available to all the components of your site. And you may access them via context as `siteConfig`:
|
||||
|
@ -100,5 +86,3 @@ const Layout = props => {
|
|||
);
|
||||
};
|
||||
```
|
||||
|
||||
## Customized configurations
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue