Skip to content

Commit 15f49d9

Browse files
committed
docs(v2): use explicit heading IDs
1 parent 03f4a92 commit 15f49d9

162 files changed

Lines changed: 1435 additions & 1435 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

website/community/resources.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,42 @@ slug: /resources
66

77
A curated list of interesting Docusaurus community projects.
88

9-
## Videos
9+
## Videos {#videos}
1010

1111
- [F8 2019: Using Docusaurus to Create Open Source Websites](https://www.youtube.com/watch?v=QcGJsf6mgZE)
1212

13-
## Articles
13+
## Articles {#articles}
1414

1515
- [Live code editing in Docusaurus](https://dev.to/mrmuhammadali/live-code-editing-in-docusaurus-ux-at-its-best-2hj1)
1616

17-
## Showcase
17+
## Showcase {#showcase}
1818

1919
See the <a href={require('@docusaurus/useBaseUrl').default('showcase')}>showcase</a>.
2020

21-
## Community plugins
21+
## Community plugins {#community-plugins}
2222

23-
### Search
23+
### Search {#search}
2424

2525
- [docusaurus-plugin-lunr](https://github.com/daldridge/docusaurus-plugin-lunr) - Docusaurus v2 plugin to create a local search index for use with Lunr.js
2626
- [docusaurus-lunr-search](https://github.com/lelouch77/docusurus-lunr-search) - Offline Search for Docusaurus v2
2727
- [docusaurus-search-local](https://github.com/cmfcmf/docusaurus-search-local) - Offline/local search for Docusaurus v2
2828
- [@easyops-cn/docusaurus-search-local](https://github.com/easyops-cn/docusaurus-search-local) - Offline/local search for Docusaurus v2 (language of zh supported)
2929

30-
### Integrations
30+
### Integrations {#integrations}
3131

3232
- [docusaurus2-dotenv](https://github.com/jonnynabors/docusaurus2-dotenv) - A Docusaurus 2 plugin that supports dotenv and other environment variables
3333
- [posthog-docusaurus](https://github.com/PostHog/posthog-docusaurus) - Integrate [PostHog](https://posthog.com/) product analytics with Docusaurus v2
3434
- [docusaurus-plugin-moesif](https://github.com/Moesif/docusaurus-plugin-moesif) - Adds [Moesif API Analytics](https://www.moesif.com/) to track user behavior and pinpoint where developers drop off in your activation funnel.
3535

36-
### Features
36+
### Features {#features}
3737

3838
- [docusaurus-theme-github-codeblock](https://github.com/saucelabs/docusaurus-theme-github-codeblock). A Docusaurus v2 plugin that supports referencing code examples from public GitHub repositories
3939
- [docusaurus-pdf](https://github.com/KohheePeace/docusaurus-pdf) - Generate documentation into PDF format
4040
- [docusaurus-plugin-sass](https://github.com/rlamana/docusaurus-plugin-sass) - Sass/SCSS stylesheets support
4141
- [docusaurus-plugin-remote-content](https://github.com/rdilweb/docusaurus-plugin-remote-content) - A Docusaurus v2 plugin that allows you to fetch content from remote sources
4242
- [docusaurus2-graphql-doc-generator](https://github.com/edno/docusaurus2-graphql-doc-generator) - A Docusaurus v2 plugin for generating documentation from a GraphQL schema
4343

44-
## Enterprise usage
44+
## Enterprise usage {#enterprise-usage}
4545

4646
- Facebook
4747
- Google

website/community/support.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ On this page we've listed some Docusaurus-related communities that you can be a
1010

1111
Before participating in Docusaurus' communities, [please read our Code of Conduct](https://engineering.fb.com/codeofconduct/). We have adopted the [Contributor Covenant](https://www.contributor-covenant.org/) and we expect that all community members adhere to the guidelines within.
1212

13-
## Stack Overflow
13+
## Stack Overflow {#stack-overflow}
1414

1515
Stack Overflow is a popular forum to ask code-level questions or if you're stuck with a specific error. Read through the [existing questions](https://stackoverflow.com/questions/tagged/docusaurus) tagged with **docusaurus** or [ask your own](https://stackoverflow.com/questions/ask?tags=docusaurus)!
1616

17-
## Discussion forums
17+
## Discussion forums {#discussion-forums}
1818

1919
There are many online forums which are a great place for discussion about best practices and application architecture as well as the future of Docusaurus. If you have an answerable code-level question, Stack Overflow is usually a better fit.
2020

@@ -23,10 +23,10 @@ There are many online forums which are a great place for discussion about best p
2323
- [#docusaurus-2-dev](https://discord.gg/6g6ASPA) for contributing help
2424
- [Reddit's Docusaurus community](https://www.reddit.com/r/docusaurus/)
2525

26-
## Feature requests
26+
## Feature requests {#feature-requests}
2727

2828
For new feature requests, you can create a post on our [Canny board](/feedback), which is a handy tool for roadmapping and allows for sorting by upvotes, which gives the core team a better indicator of what features are in high demand, as compared to GitHub issues which are harder to triage. Refrain from making a Pull Request for new features (especially large ones) as someone might already be working on it or will be part of our roadmap. Talk to us first!
2929

30-
## News
30+
## News {#news}
3131

3232
For the latest news about Docusaurus, [follow **@docusaurus** on Twitter](https://twitter.com/docusaurus) and the [official Docusaurus blog](/blog) on this website.

website/community/team.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,27 @@ import {
1010
StudentFellowsTeamRow,
1111
} from '@site/src/components/TeamProfileCards';
1212

13-
## Active Team
13+
## Active Team {#active-team}
1414

1515
The Docusaurus team works on the core functionality, plugins for the classic theme, as well as the Docusaurus documentation website.
1616

1717
Current members of the Docusaurus team are listed in alphabetical order below.
1818

1919
<ActiveTeamRow />
2020

21-
## Honorary Alumni
21+
## Honorary Alumni {#honorary-alumni}
2222

2323
Docusaurus would never be what it is today without the huge contributions from these folks who have moved on to bigger and greater things.
2424

2525
<HonoraryAlumniTeamRow />
2626

27-
## Student Fellows
27+
## Student Fellows {#student-fellows}
2828

2929
A handful of students have also worked on Docusaurus as part of their school term/internship and the [Major League Hacking Fellowship program](https://fellowship.mlh.io/), contributing amazing features such as plugin options validation, migration tooling, and a Bootstrap theme.
3030

3131
<StudentFellowsTeamRow />
3232

33-
## Acknowledgements
33+
## Acknowledgements {#acknowledgements}
3434

3535
Docusaurus was originally created by Joel Marcey. Today, Docusaurus has a few hundred open source contributors. We’d like to recognize a few people who have made significant contributions to Docusaurus and its documentation in the past and have helped maintain them over the years:
3636

website/docs/api/docusaurus.config.js.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ description: API reference for Docusaurus configuration file.
55
slug: /docusaurus.config.js
66
---
77

8-
## Overview
8+
## Overview {#overview}
99

1010
`docusaurus.config.js` contains configurations for your site and is placed in the root directory of your site.
1111

12-
## Required fields
12+
## Required fields {#required-fields}
1313

14-
### `title`
14+
### `title` {#title}
1515

1616
- Type: `string`
1717

@@ -23,7 +23,7 @@ module.exports = {
2323
};
2424
```
2525

26-
### `favicon`
26+
### `favicon` {#favicon}
2727

2828
- Type: `string`
2929

@@ -54,7 +54,7 @@ module.exports = {
5454
};
5555
```
5656

57-
### `url`
57+
### `url` {#url}
5858

5959
- Type: `string`
6060

@@ -66,7 +66,7 @@ module.exports = {
6666
};
6767
```
6868

69-
### `baseUrl`
69+
### `baseUrl` {#baseurl}
7070

7171
- Type: `string`
7272

@@ -78,9 +78,9 @@ module.exports = {
7878
};
7979
```
8080

81-
## Optional fields
81+
## Optional fields {#optional-fields}
8282

83-
### `i18n`
83+
### `i18n` {#i18n}
8484

8585
- Type: `Object`
8686

@@ -110,7 +110,7 @@ module.exports = {
110110
- `label`: the label to use for this locale
111111
- `direction`: `ltr` (default) or `rtl` (for [right-to-left languages](https://developer.mozilla.org/en-US/docs/Glossary/rtl) like Araric, Hebrew, etc.)
112112

113-
### `noIndex`
113+
### `noIndex` {#noindex}
114114

115115
- Type: `boolean`
116116

@@ -124,7 +124,7 @@ module.exports = {
124124
};
125125
```
126126

127-
### `onBrokenLinks`
127+
### `onBrokenLinks` {#onbrokenlinks}
128128

129129
- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`
130130

@@ -138,23 +138,23 @@ The broken links detection is only available for a production build (`docusaurus
138138

139139
:::
140140

141-
### `onBrokenMarkdownLinks`
141+
### `onBrokenMarkdownLinks` {#onbrokenmarkdownlinks}
142142

143143
- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`
144144

145145
The behavior of Docusaurus, when it detects any broken markdown link.
146146

147147
By default, it prints a warning, to let you know about your broken markdown link, but you can change this security if needed.
148148

149-
### `onDuplicateRoutes`
149+
### `onDuplicateRoutes` {#onduplicateroutes}
150150

151151
- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'`
152152

153153
The behavior of Docusaurus when it detects any [duplicate routes](/guides/creating-pages.md#duplicate-routes).
154154

155155
By default, it displays a warning after you run `yarn start` or `yarn build`.
156156

157-
### `tagline`
157+
### `tagline` {#tagline}
158158

159159
- Type: `string`
160160

@@ -167,7 +167,7 @@ module.exports = {
167167
};
168168
```
169169

170-
### `organizationName`
170+
### `organizationName` {#organizationname}
171171

172172
- Type: `string`
173173

@@ -180,7 +180,7 @@ module.exports = {
180180
};
181181
```
182182

183-
### `projectName`
183+
### `projectName` {#projectname}
184184

185185
- Type: `string`
186186

@@ -192,7 +192,7 @@ module.exports = {
192192
};
193193
```
194194

195-
### `githubHost`
195+
### `githubHost` {#githubhost}
196196

197197
- Type: `string`
198198

@@ -204,7 +204,7 @@ module.exports = {
204204
};
205205
```
206206

207-
### `themeConfig`
207+
### `themeConfig` {#themeconfig}
208208

209209
- Type: `Object`
210210

@@ -273,7 +273,7 @@ module.exports = {
273273
};
274274
```
275275

276-
### `plugins`
276+
### `plugins` {#plugins}
277277

278278
<!-- TODO: configuration for plugins -->
279279

@@ -285,7 +285,7 @@ module.exports = {
285285
};
286286
```
287287

288-
### `themes`
288+
### `themes` {#themes}
289289

290290
<!-- TODO: configuration for plugins -->
291291

@@ -297,7 +297,7 @@ module.exports = {
297297
};
298298
```
299299

300-
### `presets`
300+
### `presets` {#presets}
301301

302302
<!-- TODO: configuration for presets -->
303303

@@ -309,7 +309,7 @@ module.exports = {
309309
};
310310
```
311311

312-
### `customFields`
312+
### `customFields` {#customfields}
313313

314314
Docusaurus guards `docusaurus.config.js` from unknown fields. To add a custom field, define it on `customFields`.
315315

@@ -330,7 +330,7 @@ Attempting to add unknown field in the config will lead to error in build time:
330330
Error: The field(s) 'foo', 'bar' are not recognized in docusaurus.config.js
331331
```
332332

333-
### `scripts`
333+
### `scripts` {#scripts}
334334

335335
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>`.
336336

@@ -355,7 +355,7 @@ module.exports = {
355355
};
356356
```
357357

358-
### `clientModules`
358+
### `clientModules` {#clientmodules}
359359

360360
An array of client modules to load globally on your site:
361361

@@ -372,7 +372,7 @@ module.exports = {
372372

373373
See also: [`getClientModules()`](lifecycle-apis.md#getclientmodules).
374374

375-
### `ssrTemplate`
375+
### `ssrTemplate` {#ssrtemplate}
376376

377377
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`.
378378

@@ -416,7 +416,7 @@ module.exports = {
416416
};
417417
```
418418

419-
### `stylesheets`
419+
### `stylesheets` {#stylesheets}
420420

421421
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>`.
422422

@@ -438,7 +438,7 @@ module.exports = {
438438
};
439439
```
440440

441-
### `titleDelimiter`
441+
### `titleDelimiter` {#titledelimiter}
442442

443443
- Type: `string`
444444

@@ -452,7 +452,7 @@ module.exports = {
452452
};
453453
```
454454

455-
### `baseUrlIssueBanner`
455+
### `baseUrlIssueBanner` {#baseurlissuebanner}
456456

457457
- Type: `boolean`
458458

website/docs/api/plugins/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ slug: '/api/plugins'
77

88
We provide official Docusaurus plugins.
99

10-
## Content plugins
10+
## Content plugins {#content-plugins}
1111

1212
These plugins are responsible to load your site's content, and create pages for your theme to render.
1313

1414
- [@docusaurus/plugin-content-docs](./plugin-content-docs.md)
1515
- [@docusaurus/plugin-content-blog](./plugin-content-blog.md)
1616
- [@docusaurus/plugin-content-pages](./plugin-content-pages.md)
1717

18-
## Behavior plugins
18+
## Behavior plugins {#behavior-plugins}
1919

2020
These plugins will add a useful behavior to your Docusaurus site.
2121

website/docs/api/plugins/plugin-client-redirects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ Before using this plugin, you should look if your hosting provider doesn't offer
2222

2323
:::
2424

25-
## Installation
25+
## Installation {#installation}
2626

2727
```bash npm2yarn
2828
npm install --save @docusaurus/plugin-client-redirects
2929
```
3030

31-
## Configuration
31+
## Configuration {#configuration}
3232

3333
Main usecase: you have `/myDocusaurusPage`, and you want to redirect to this page from `/myDocusaurusPage.html`:
3434

0 commit comments

Comments
 (0)