mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-03 00:39:45 +02:00
docs(v2): use explicit heading IDs (#4460)
This commit is contained in:
Alexey Pyltsyn
GitHub
parent
962c3748ea
commit
291a72fbae
162 changed files with 1435 additions and 1435 deletions
|
|
@ -5,13 +5,13 @@ description: API reference for Docusaurus configuration file.
|
|||
slug: /docusaurus.config.js
|
||||
---
|
||||
|
||||
## Overview
|
||||
## Overview {#overview}
|
||||
|
||||
`docusaurus.config.js` contains configurations for your site and is placed in the root directory of your site.
|
||||
|
||||
## Required fields
|
||||
## Required fields {#required-fields}
|
||||
|
||||
### `title`
|
||||
### `title` {#title}
|
||||
|
||||
- Type: `string`
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `favicon`
|
||||
### `favicon` {#favicon}
|
||||
|
||||
- Type: `string`
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `url`
|
||||
### `url` {#url}
|
||||
|
||||
- Type: `string`
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `baseUrl`
|
||||
### `baseUrl` {#baseurl}
|
||||
|
||||
- Type: `string`
|
||||
|
||||
|
|
@ -78,9 +78,9 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
## Optional fields
|
||||
## Optional fields {#optional-fields}
|
||||
|
||||
### `i18n`
|
||||
### `i18n` {#i18n}
|
||||
|
||||
- Type: `Object`
|
||||
|
||||
|
|
@ -110,7 +110,7 @@ module.exports = {
|
|||
- `label`: the label to use for this locale
|
||||
- `direction`: `ltr` (default) or `rtl` (for [right-to-left languages](https://developer.mozilla.org/en-US/docs/Glossary/rtl) like Araric, Hebrew, etc.)
|
||||
|
||||
### `noIndex`
|
||||
### `noIndex` {#noindex}
|
||||
|
||||
- Type: `boolean`
|
||||
|
||||
|
|
@ -124,7 +124,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `onBrokenLinks`
|
||||
### `onBrokenLinks` {#onbrokenlinks}
|
||||
|
||||
- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`
|
||||
|
||||
|
|
@ -138,7 +138,7 @@ The broken links detection is only available for a production build (`docusaurus
|
|||
|
||||
:::
|
||||
|
||||
### `onBrokenMarkdownLinks`
|
||||
### `onBrokenMarkdownLinks` {#onbrokenmarkdownlinks}
|
||||
|
||||
- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`
|
||||
|
||||
|
|
@ -146,7 +146,7 @@ The behavior of Docusaurus, when it detects any broken markdown link.
|
|||
|
||||
By default, it prints a warning, to let you know about your broken markdown link, but you can change this security if needed.
|
||||
|
||||
### `onDuplicateRoutes`
|
||||
### `onDuplicateRoutes` {#onduplicateroutes}
|
||||
|
||||
- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`
|
||||
|
||||
|
|
@ -154,7 +154,7 @@ The behavior of Docusaurus when it detects any [duplicate routes](/guides/creati
|
|||
|
||||
By default, it displays a warning after you run `yarn start` or `yarn build`.
|
||||
|
||||
### `tagline`
|
||||
### `tagline` {#tagline}
|
||||
|
||||
- Type: `string`
|
||||
|
||||
|
|
@ -167,7 +167,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `organizationName`
|
||||
### `organizationName` {#organizationname}
|
||||
|
||||
- Type: `string`
|
||||
|
||||
|
|
@ -180,7 +180,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `projectName`
|
||||
### `projectName` {#projectname}
|
||||
|
||||
- Type: `string`
|
||||
|
||||
|
|
@ -192,7 +192,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `githubHost`
|
||||
### `githubHost` {#githubhost}
|
||||
|
||||
- Type: `string`
|
||||
|
||||
|
|
@ -204,7 +204,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `themeConfig`
|
||||
### `themeConfig` {#themeconfig}
|
||||
|
||||
- Type: `Object`
|
||||
|
||||
|
|
@ -273,7 +273,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `plugins`
|
||||
### `plugins` {#plugins}
|
||||
|
||||
<!-- TODO: configuration for plugins -->
|
||||
|
||||
|
|
@ -285,7 +285,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `themes`
|
||||
### `themes` {#themes}
|
||||
|
||||
<!-- TODO: configuration for plugins -->
|
||||
|
||||
|
|
@ -297,7 +297,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `presets`
|
||||
### `presets` {#presets}
|
||||
|
||||
<!-- TODO: configuration for presets -->
|
||||
|
||||
|
|
@ -309,7 +309,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `customFields`
|
||||
### `customFields` {#customfields}
|
||||
|
||||
Docusaurus guards `docusaurus.config.js` from unknown fields. To add a custom field, define it on `customFields`.
|
||||
|
||||
|
|
@ -330,7 +330,7 @@ Attempting to add unknown field in the config will lead to error in build time:
|
|||
Error: The field(s) 'foo', 'bar' are not recognized in docusaurus.config.js
|
||||
```
|
||||
|
||||
### `scripts`
|
||||
### `scripts` {#scripts}
|
||||
|
||||
An array of scripts to load. The values can be either strings or plain objects of attribute-value maps. The `<script>` tags will be inserted in the HTML `<head>`.
|
||||
|
||||
|
|
@ -355,7 +355,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `clientModules`
|
||||
### `clientModules` {#clientmodules}
|
||||
|
||||
An array of client modules to load globally on your site:
|
||||
|
||||
|
|
@ -372,7 +372,7 @@ module.exports = {
|
|||
|
||||
See also: [`getClientModules()`](lifecycle-apis.md#getclientmodules).
|
||||
|
||||
### `ssrTemplate`
|
||||
### `ssrTemplate` {#ssrtemplate}
|
||||
|
||||
An HTML template written in [Eta's syntax](https://eta.js.org/docs/syntax#syntax-overview) that will be used to render your application. This can be used to set custom attributes on the `body` tags, additional `meta` tags, customize the `viewport`, etc. Please note that Docusaurus will rely on the template to be correctly structured in order to function properly, once you do customize it, you will have to make sure that your template is compliant with the requirements from `upstream`.
|
||||
|
||||
|
|
@ -416,7 +416,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `stylesheets`
|
||||
### `stylesheets` {#stylesheets}
|
||||
|
||||
An array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The `<link>` tags will be inserted in the HTML `<head>`.
|
||||
|
||||
|
|
@ -438,7 +438,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `titleDelimiter`
|
||||
### `titleDelimiter` {#titledelimiter}
|
||||
|
||||
- Type: `string`
|
||||
|
||||
|
|
@ -452,7 +452,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `baseUrlIssueBanner`
|
||||
### `baseUrlIssueBanner` {#baseurlissuebanner}
|
||||
|
||||
- Type: `boolean`
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ slug: '/api/plugins'
|
|||
|
||||
We provide official Docusaurus plugins.
|
||||
|
||||
## Content plugins
|
||||
## Content plugins {#content-plugins}
|
||||
|
||||
These plugins are responsible to load your site's content, and create pages for your theme to render.
|
||||
|
||||
|
|
@ -15,7 +15,7 @@ These plugins are responsible to load your site's content, and create pages for
|
|||
- [@docusaurus/plugin-content-blog](./plugin-content-blog.md)
|
||||
- [@docusaurus/plugin-content-pages](./plugin-content-pages.md)
|
||||
|
||||
## Behavior plugins
|
||||
## Behavior plugins {#behavior-plugins}
|
||||
|
||||
These plugins will add a useful behavior to your Docusaurus site.
|
||||
|
||||
|
|
|
|||
|
|
@ -22,13 +22,13 @@ Before using this plugin, you should look if your hosting provider doesn't offer
|
|||
|
||||
:::
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-client-redirects
|
||||
```
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
Main usecase: you have `/myDocusaurusPage`, and you want to redirect to this page from `/myDocusaurusPage.html`:
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ slug: '/api/plugins/@docusaurus/plugin-content-blog'
|
|||
|
||||
Provides the [Blog](blog.md) feature and is the default blog plugin for Docusaurus.
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-content-blog
|
||||
|
|
@ -18,7 +18,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
|
|||
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
@ -118,18 +118,18 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
## i18n
|
||||
## i18n {#i18n}
|
||||
|
||||
Read the [i18n introduction](../../i18n/i18n-introduction.md) first.
|
||||
|
||||
### Translation files location
|
||||
### Translation files location {#translation-files-location}
|
||||
|
||||
- **Base path**: `website/i18n/<locale>/docusaurus-plugin-content-blog`
|
||||
- **Multi-instance path**: `website/i18n/<locale>/docusaurus-plugin-content-blog-<pluginId>`
|
||||
- **JSON files**: N/A
|
||||
- **Markdown files**: `website/i18n/<locale>/docusaurus-plugin-content-blog`
|
||||
|
||||
### Example file-system structure
|
||||
### Example file-system structure {#example-file-system-structure}
|
||||
|
||||
```bash
|
||||
website/i18n/<locale>/docusaurus-plugin-content-blog
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ slug: '/api/plugins/@docusaurus/plugin-content-docs'
|
|||
|
||||
Provides the [Docs](../../guides/docs/docs-introduction.md) functionality and is the default docs plugin for Docusaurus.
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-content-docs
|
||||
|
|
@ -18,7 +18,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
|
|||
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
@ -148,7 +148,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
## Markdown Frontmatter
|
||||
## Markdown Frontmatter {#markdown-frontmatter}
|
||||
|
||||
Markdown documents can use the following markdown frontmatter metadata fields, enclosed by a line `---` on either side:
|
||||
|
||||
|
|
@ -183,18 +183,18 @@ slug: /myDoc
|
|||
My Document Markdown content
|
||||
```
|
||||
|
||||
## i18n
|
||||
## i18n {#i18n}
|
||||
|
||||
Read the [i18n introduction](../../i18n/i18n-introduction.md) first.
|
||||
|
||||
### Translation files location
|
||||
### Translation files location {#translation-files-location}
|
||||
|
||||
- **Base path**: `website/i18n/<locale>/docusaurus-plugin-content-docs`
|
||||
- **Multi-instance path**: `website/i18n/<locale>/docusaurus-plugin-content-docs-<pluginId>`
|
||||
- **JSON files**: extracted with [`docusaurus write-translations`](../../cli.md#docusaurus-write-translations)
|
||||
- **Markdown files**: `website/i18n/<locale>/docusaurus-plugin-content-docs/<version>`
|
||||
|
||||
### Example file-system structure
|
||||
### Example file-system structure {#example-file-system-structure}
|
||||
|
||||
```bash
|
||||
website/i18n/<locale>/docusaurus-plugin-content-docs
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ slug: '/api/plugins/@docusaurus/plugin-content-pages'
|
|||
|
||||
The default pages plugin for Docusaurus. The classic template ships with this plugin with default configurations. This plugin provides [creating pages](guides/creating-pages.md) functionality.
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-content-pages
|
||||
|
|
@ -18,7 +18,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
|
|||
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
@ -67,18 +67,18 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
## i18n
|
||||
## i18n {#i18n}
|
||||
|
||||
Read the [i18n introduction](../../i18n/i18n-introduction.md) first.
|
||||
|
||||
### Translation files location
|
||||
### Translation files location {#translation-files-location}
|
||||
|
||||
- **Base path**: `website/i18n/<locale>/docusaurus-plugin-content-pages`
|
||||
- **Multi-instance path**: `website/i18n/<locale>/docusaurus-plugin-content-pages-<pluginId>`
|
||||
- **JSON files**: extracted with [`docusaurus write-translations`](../../cli.md#docusaurus-write-translations)
|
||||
- **Markdown files**: `website/i18n/<locale>/docusaurus-plugin-content-pages`
|
||||
|
||||
### Example file-system structure
|
||||
### Example file-system structure {#example-file-system-structure}
|
||||
|
||||
```bash
|
||||
website/i18n/<locale>/docusaurus-plugin-content-pages
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ If you don't have any sensitive information, you can keep it on in production [l
|
|||
|
||||
:::
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-debug
|
||||
|
|
@ -30,7 +30,7 @@ By default, it's enabled in dev, and disabled in prod, to avoid exposing potenti
|
|||
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ slug: '/api/plugins/@docusaurus/plugin-google-analytics'
|
|||
|
||||
The default [Google Analytics](https://developers.google.com/analytics/devguides/collection/analyticsjs/) plugin. It is a JavaScript library for measuring how users interact with your website.
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-google-analytics
|
||||
|
|
@ -18,7 +18,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
|
|||
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ slug: '/api/plugins/@docusaurus/plugin-google-gtag'
|
|||
|
||||
The default [Global Site Tag (gtag.js)](https://developers.google.com/analytics/devguides/collection/gtagjs/) plugin. It is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, and Google Marketing Platform. This section describes how to configure a Docusaurus site to enable global site tag for Google Analytics.
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-google-gtag
|
||||
|
|
@ -18,7 +18,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
|
|||
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
|
|||
|
|
@ -6,13 +6,13 @@ slug: '/api/plugins/@docusaurus/plugin-ideal-image'
|
|||
|
||||
Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) **in the production builds**.
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-ideal-image
|
||||
```
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
Modify your `docusaurus.config.js`
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ module.exports = {
|
|||
}
|
||||
```
|
||||
|
||||
## Usage
|
||||
## Usage {#usage}
|
||||
|
||||
This plugin supports the PNG, GIF and JPG formats only.
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ import thumbnail from './path/to/img.png';
|
|||
<Image img={require('./path/to/img.png')} />
|
||||
```
|
||||
|
||||
## Options
|
||||
## Options {#options}
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
|
|
|
|||
|
|
@ -6,13 +6,13 @@ slug: '/api/plugins/@docusaurus/plugin-pwa'
|
|||
|
||||
Docusaurus Plugin to add PWA support using [Workbox](https://developers.google.com/web/tools/workbox). This plugin generates a [Service Worker](https://developers.google.com/web/fundamentals/primers/service-workers) in production build only, and allows you to create fully PWA-compliant documentation site with offline and installation support.
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-pwa
|
||||
```
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
Create a [PWA manifest](https://web.dev/add-manifest/) at `./static/manifest.json`.
|
||||
|
||||
|
|
@ -53,7 +53,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
## Progressive Web App
|
||||
## Progressive Web App {#progressive-web-app}
|
||||
|
||||
Having a service worker installed is not enough to make your application a PWA. You'll need to at least include a [Web App Manifest](https://developer.mozilla.org/en-US/docs/Web/Manifest) and have the correct tags in `<head>` ([Options > pwaHead](#pwahead)).
|
||||
|
||||
|
|
@ -61,7 +61,7 @@ After deployment, you can use [Lighthouse](https://developers.google.com/web/too
|
|||
|
||||
For a more exhaustive list of what it takes for your site to be a PWA, refer to the [PWA Checklist](https://developers.google.com/web/progressive-web-apps/checklist)
|
||||
|
||||
## App installation support
|
||||
## App installation support {#app-installation-support}
|
||||
|
||||
If your browser supports it, you should be able to install a Docusaurus site as an app.
|
||||
|
||||
|
|
@ -73,7 +73,7 @@ App installation requires the https protocol and a valid manifest.
|
|||
|
||||
:::
|
||||
|
||||
## Offline mode (precaching)
|
||||
## Offline mode (precaching) {#offline-mode-precaching}
|
||||
|
||||
We enable users to browse a Docusaurus site offline, by using service-worker precaching.
|
||||
|
||||
|
|
@ -95,9 +95,9 @@ Offline mode / precaching requires downloading all the static assets of the site
|
|||
|
||||
:::
|
||||
|
||||
## Options
|
||||
## Options {#options}
|
||||
|
||||
### `debug`
|
||||
### `debug` {#debug}
|
||||
|
||||
- Type: `boolean`
|
||||
- Default: `false`
|
||||
|
|
@ -109,7 +109,7 @@ Turn debug mode on:
|
|||
- Unoptimized SW file output
|
||||
- Source maps
|
||||
|
||||
### `offlineModeActivationStrategies`
|
||||
### `offlineModeActivationStrategies` {#offlinemodeactivationstrategies}
|
||||
|
||||
- Type: `Array<'appInstalled' | 'mobile' | 'saveData'| 'queryString' | 'always'>`
|
||||
- Default: `['appInstalled','queryString','standalone']`
|
||||
|
|
@ -139,7 +139,7 @@ The [`standalone` strategy](https://petelepage.com/blog/2019/07/is-my-pwa-instal
|
|||
|
||||
:::
|
||||
|
||||
### `injectManifestConfig`
|
||||
### `injectManifestConfig` {#injectmanifestconfig}
|
||||
|
||||
[Workbox options](https://developers.google.com/web/tools/workbox/reference-docs/latest/module-workbox-build#.injectManifest) to pass to `workbox.injectManifest()`. This gives you control over which assets will be precached, and be available offline.
|
||||
|
||||
|
|
@ -170,7 +170,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `reloadPopup`
|
||||
### `reloadPopup` {#reloadpopup}
|
||||
|
||||
- Type: `string | false`
|
||||
- Default: `'@theme/PwaReloadPopup'`
|
||||
|
|
@ -191,7 +191,7 @@ The default theme includes an implementation for the reload popup and uses [Infi
|
|||
|
||||
|
||||
|
||||
### `pwaHead`
|
||||
### `pwaHead` {#pwahead}
|
||||
|
||||
- Type: `Array<{ tagName: string } & Record<string,string>>`
|
||||
- Default: `[]`
|
||||
|
|
@ -258,7 +258,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `swCustom`
|
||||
### `swCustom` {#swcustom}
|
||||
|
||||
- Type: `string | undefined`
|
||||
- Default: `undefined`
|
||||
|
|
@ -291,7 +291,7 @@ export default function swCustom(params) {
|
|||
|
||||
The module should have a `default` function export, and receives some params.
|
||||
|
||||
### `swRegister`
|
||||
### `swRegister` {#swregister}
|
||||
|
||||
- Type: `string | false`
|
||||
- Default: `'docusaurus-plugin-pwa/src/registerSW.js'`
|
||||
|
|
@ -300,7 +300,7 @@ Adds an entry before the Docusaurus app so that registration can happen before t
|
|||
|
||||
Passing `false` will disable registration entirely.
|
||||
|
||||
## Manifest example
|
||||
## Manifest example {#manifest-example}
|
||||
|
||||
The Docusaurus site manifest can serve as an inspiration:
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ slug: '/api/plugins/@docusaurus/plugin-sitemap'
|
|||
|
||||
This plugin creates sitemap for your site so that search engine crawlers can crawl your site more accurately.
|
||||
|
||||
## Installation
|
||||
## Installation {#installation}
|
||||
|
||||
```bash npm2yarn
|
||||
npm install --save @docusaurus/plugin-sitemap
|
||||
|
|
@ -18,7 +18,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it
|
|||
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
## Configuration {#configuration}
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ slug: '/api/themes'
|
|||
|
||||
We provide official Docusaurus themes.
|
||||
|
||||
## Main themes
|
||||
## Main themes {#main-themes}
|
||||
|
||||
The main themes implement the user interface for the [docs](../plugins/plugin-content-docs.md), [blog](../plugins/plugin-content-blog.md) and [pages](../plugins/plugin-content-pages.md) plugins.
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ We are not there yet: only the classic theme is production ready.
|
|||
|
||||
:::
|
||||
|
||||
## Enhancement themes
|
||||
## Enhancement themes {#enhancement-themes}
|
||||
|
||||
These themes will enhance the existing main themes with additional user-interface related features.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,9 +6,9 @@ slug: '/api/themes/configuration'
|
|||
|
||||
This configuration applies to all [main themes](./overview.md).
|
||||
|
||||
## Common
|
||||
## Common {#common}
|
||||
|
||||
### Color mode - dark mode
|
||||
### Color mode - dark mode {#color-mode---dark-mode}
|
||||
|
||||
The classic theme provides by default light and dark mode support, with a navbar switch for the user.
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ If you only want to support one color mode, you likely want to ignore user syste
|
|||
|
||||
:::
|
||||
|
||||
### Meta image
|
||||
### Meta image {#meta-image}
|
||||
|
||||
You can configure a default image that will be used for your meta tag, in particular `og:image` and `twitter:image`.
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Metadatas
|
||||
### Metadatas {#metadatas}
|
||||
|
||||
You can configure additional html metadatas (and override existing ones).
|
||||
|
||||
|
|
@ -96,7 +96,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Announcement bar
|
||||
### Announcement bar {#announcement-bar}
|
||||
|
||||
Sometimes you want to announce something in your website. Just for such a case, you can add an announcement bar. This is a non-fixed and optionally dismissable panel above the navbar.
|
||||
|
||||
|
|
@ -117,18 +117,18 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
## i18n
|
||||
## i18n {#i18n}
|
||||
|
||||
Read the [i18n introduction](../../i18n/i18n-introduction.md) first.
|
||||
|
||||
### Translation files location
|
||||
### Translation files location {#translation-files-location}
|
||||
|
||||
- **Base path**: `website/i18n/<locale>/docusaurus-theme-<themeName>`
|
||||
- **Multi-instance path**: N/A
|
||||
- **JSON files**: extracted with [`docusaurus write-translations`](../../cli.md#docusaurus-write-translations)
|
||||
- **Markdown files**: `N/A
|
||||
|
||||
### Example file-system structure
|
||||
### Example file-system structure {#example-file-system-structure}
|
||||
|
||||
```bash
|
||||
website/i18n/<locale>/docusaurus-theme-classic
|
||||
|
|
@ -138,9 +138,9 @@ website/i18n/<locale>/docusaurus-theme-classic
|
|||
└── footer.json
|
||||
```
|
||||
|
||||
## Hooks
|
||||
## Hooks {#hooks}
|
||||
|
||||
### `useThemeContext`
|
||||
### `useThemeContext` {#usethemecontext}
|
||||
|
||||
React hook to access theme context. This context contains functions for setting light and dark mode and boolean property, indicating which mode is currently in use.
|
||||
|
||||
|
|
@ -175,9 +175,9 @@ function ExamplePage() {
|
|||
|
||||
:::
|
||||
|
||||
## Navbar
|
||||
## Navbar {#navbar}
|
||||
|
||||
### Navbar title & logo
|
||||
### Navbar title & logo {#navbar-title--logo}
|
||||
|
||||
You can add a logo and title to the navbar via `themeConfig.navbar`. Logo can be placed in [static folder](static-assets.md). Logo URL is set to base URL of your site by default. Although you can specify your own URL for the logo, if it is an external link, it will open in a new tab. In addition, you can override a value for the target attribute of logo link, it can come in handy if you are hosting docs website in a subdirectory of your main website, and in which case you probably do not need a link in the logo to the main website will open in a new tab.
|
||||
|
||||
|
|
@ -202,7 +202,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Navbar items
|
||||
### Navbar items {#navbar-items}
|
||||
|
||||
You can add items to the navbar via `themeConfig.navbar.items`.
|
||||
|
||||
|
|
@ -250,7 +250,7 @@ React Router should automatically apply active link styling to links, but you ca
|
|||
|
||||
Outbound (external) links automatically get `target="_blank" rel="noopener noreferrer"` attributes.
|
||||
|
||||
### Navbar dropdown
|
||||
### Navbar dropdown {#navbar-dropdown}
|
||||
|
||||
Navbar items can also be dropdown items by specifying the `items`, an inner array of navbar items.
|
||||
|
||||
|
|
@ -282,7 +282,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Navbar doc link
|
||||
### Navbar doc link {#navbar-doc-link}
|
||||
|
||||
If you want to link to a specific doc, this special navbar item type will render the link to the doc of the provided `docId`. It will get the class `navbar__link--active` as long as you browse a doc of the same sidebar.
|
||||
|
||||
|
|
@ -309,7 +309,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Navbar docs version dropdown
|
||||
### Navbar docs version dropdown {#navbar-docs-version-dropdown}
|
||||
|
||||
If you use docs with versioning, this special navbar item type that will render a dropdown with all your site's available versions.
|
||||
|
||||
|
|
@ -338,7 +338,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Navbar docs version
|
||||
### Navbar docs version {#navbar-docs-version}
|
||||
|
||||
If you use docs with versioning, this special navbar item type will link to the active/browsed version of your doc (depends on the current url), and fallback to the latest version.
|
||||
|
||||
|
|
@ -364,7 +364,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Navbar locale dropdown
|
||||
### Navbar locale dropdown {#navbar-locale-dropdown}
|
||||
|
||||
If you use the [i18n feature](../../i18n/i18n-introduction.md), this special navbar item type will render a dropdown with all your site's available locales.
|
||||
|
||||
|
|
@ -395,7 +395,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Navbar search
|
||||
### Navbar search {#navbar-search}
|
||||
|
||||
If you use the [search](../../search.md), the search bar will be the rightmost element in the navbar.
|
||||
|
||||
|
|
@ -416,7 +416,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Auto-hide sticky navbar
|
||||
### Auto-hide sticky navbar {#auto-hide-sticky-navbar}
|
||||
|
||||
You can enable this cool UI feature that automatically hides the navbar when a user starts scrolling down the page, and show it again when the user scrolls up.
|
||||
|
||||
|
|
@ -432,7 +432,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### Navbar style
|
||||
### Navbar style {#navbar-style}
|
||||
|
||||
You can set the static Navbar style without disabling the theme switching ability. The selected style will always apply no matter which theme user have selected.
|
||||
|
||||
|
|
@ -452,17 +452,17 @@ module.exports = {
|
|||
|
||||
<!--
|
||||
|
||||
## Footer
|
||||
## Footer {#footer}
|
||||
|
||||
TODO.
|
||||
|
||||
-->
|
||||
|
||||
## CodeBlock
|
||||
## CodeBlock {#codeblock}
|
||||
|
||||
Docusaurus uses [Prism React Renderer](https://github.com/FormidableLabs/prism-react-renderer) to highlight code blocks.
|
||||
|
||||
### Theme
|
||||
### Theme {#theme}
|
||||
|
||||
By default, we use [Palenight](https://github.com/FormidableLabs/prism-react-renderer/blob/master/src/themes/palenight.js) as syntax highlighting theme. You can specify a custom theme from the [list of available themes](https://github.com/FormidableLabs/prism-react-renderer/tree/master/src/themes). If you want to use a different syntax highlighting theme when the site is in dark mode, you may also do so.
|
||||
|
||||
|
|
@ -485,7 +485,7 @@ If you use the line highlighting Markdown syntax, you might need to specify a di
|
|||
|
||||
:::
|
||||
|
||||
### Default language
|
||||
### Default language {#default-language}
|
||||
|
||||
You can set a default language for code blocks if no language is added after the opening triple backticks (i.e. ```). Note that a valid [language name](https://prismjs.com/#supported-languages) must be passed, e.g.:
|
||||
|
||||
|
|
@ -501,7 +501,7 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
## Footer
|
||||
## Footer {#footer-1}
|
||||
|
||||
You can add logo and a copyright to the footer via `themeConfig.footer`. Logo can be placed in [static folder](static-assets.md). Logo URL works in the same way of the navbar logo.
|
||||
|
||||
|
|
@ -517,7 +517,7 @@ You can add logo and a copyright to the footer via `themeConfig.footer`. Logo ca
|
|||
}
|
||||
```
|
||||
|
||||
## Footer Links
|
||||
## Footer Links {#footer-links}
|
||||
|
||||
You can add links to the navbar via `themeConfig.footer.links`:
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ This theme provides a `@theme/CodeBlock` component that is powered by react-live
|
|||
npm install --save @docusaurus/theme-live-codeblock
|
||||
```
|
||||
|
||||
### Configuration
|
||||
### Configuration {#configuration}
|
||||
|
||||
```jsx title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue