3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-04 01:09:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(v2): use codeblock title syntax instead of comments (#2473)

Browse source
This commit is contained in:
Yangshun Tay 2020-03-29 01:08:50 +08:00 • committed by GitHub
parent b8c888b1b1
commit 36ea74504e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 114 additions and 211 deletions
Download patch file Download diff file Expand all files Collapse all files

20
website/docs/configuration.md
View file

@ -38,8 +38,7 @@ It is recommended to check the [deployment docs](deployment.md) for more informa
List the installed [themes](using-themes.md), [plugins](using-plugins.md), and [presets](presets.md) for your site in the `themes`, `plugins`, and `presets` fields, respectively. These are typically npm packages:
```js
// docusaurus.config.js
```js title="docusaurus.config.js"
module.exports = {
// ...
plugins: [
@ -52,8 +51,7 @@ module.exports = {
They can also be loaded from local directories:
```js
// docusaurus.config.js
```js title="docusaurus.config.js"
const path = require('path');
module.exports = {
@ -64,8 +62,7 @@ module.exports = {
To specify options for a plugin or theme, replace the name of the plugin or theme in the config file with an array containing the name and an options object:
```js
// docusaurus.config.js
```js title="docusaurus.config.js"
module.exports = {
// ...
plugins: [
@ -85,8 +82,7 @@ module.exports = {
To specify options for a plugin or theme that is bundled in a preset, pass the options through the `presets` field. In this example, `docs` refers to `@docusaurus/plugin-content-docs` and `theme` refers to `@docusaurus/theme-classic`.
```js
//docusaurus.config.js
```js title="docusaurus.config.js"
module.exports = {
// ...
presets: [
@ -113,13 +109,14 @@ Docusaurus guards `docusaurus.config.js` from unknown fields. To add a custom fi
Example:
```js {3-6}
// docusaurus.config.js
```js {3-6} title="docusaurus.config.js"
module.exports = {
...
customFields: {
image: '',
keywords: [],
},
...
};
```
@ -156,8 +153,7 @@ Here are some steps you need to follow for a "docs-only mode":
1. Set the `routeBasePath` property of the `docs` object in `@docusaurus/preset-classic` in `docusaurus.config.js` to the root of your site:
```js {9}
// docusaurus.config.js
```js {8} title="docusaurus.config.js"
module.exports = {
// ...
presets: [