diff --git a/website/community/resources.md b/website/community/resources.md index 343a0a2186..6e1e38f039 100644 --- a/website/community/resources.md +++ b/website/community/resources.md @@ -6,34 +6,34 @@ slug: /resources A curated list of interesting Docusaurus community projects. -## Videos +## Videos {#videos} - [F8 2019: Using Docusaurus to Create Open Source Websites](https://www.youtube.com/watch?v=QcGJsf6mgZE) -## Articles +## Articles {#articles} - [Live code editing in Docusaurus](https://dev.to/mrmuhammadali/live-code-editing-in-docusaurus-ux-at-its-best-2hj1) -## Showcase +## Showcase {#showcase} See the showcase. -## Community plugins +## Community plugins {#community-plugins} -### Search +### Search {#search} - [docusaurus-plugin-lunr](https://github.com/daldridge/docusaurus-plugin-lunr) - Docusaurus v2 plugin to create a local search index for use with Lunr.js - [docusaurus-lunr-search](https://github.com/lelouch77/docusurus-lunr-search) - Offline Search for Docusaurus v2 - [docusaurus-search-local](https://github.com/cmfcmf/docusaurus-search-local) - Offline/local search for Docusaurus v2 - [@easyops-cn/docusaurus-search-local](https://github.com/easyops-cn/docusaurus-search-local) - Offline/local search for Docusaurus v2 (language of zh supported) -### Integrations +### Integrations {#integrations} - [docusaurus2-dotenv](https://github.com/jonnynabors/docusaurus2-dotenv) - A Docusaurus 2 plugin that supports dotenv and other environment variables - [posthog-docusaurus](https://github.com/PostHog/posthog-docusaurus) - Integrate [PostHog](https://posthog.com/) product analytics with Docusaurus v2 - [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. -### Features +### Features {#features} - [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 - [docusaurus-pdf](https://github.com/KohheePeace/docusaurus-pdf) - Generate documentation into PDF format @@ -41,7 +41,7 @@ See the showcase - [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 - [docusaurus2-graphql-doc-generator](https://github.com/edno/docusaurus2-graphql-doc-generator) - A Docusaurus v2 plugin for generating documentation from a GraphQL schema -## Enterprise usage +## Enterprise usage {#enterprise-usage} - Facebook - Google diff --git a/website/community/support.md b/website/community/support.md index 26269330d9..75f7e034b7 100644 --- a/website/community/support.md +++ b/website/community/support.md @@ -10,11 +10,11 @@ On this page we've listed some Docusaurus-related communities that you can be a 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. -## Stack Overflow +## Stack Overflow {#stack-overflow} 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)! -## Discussion forums +## Discussion forums {#discussion-forums} 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. @@ -23,10 +23,10 @@ There are many online forums which are a great place for discussion about best p - [#docusaurus-2-dev](https://discord.gg/6g6ASPA) for contributing help - [Reddit's Docusaurus community](https://www.reddit.com/r/docusaurus/) -## Feature requests +## Feature requests {#feature-requests} 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! -## News +## News {#news} For the latest news about Docusaurus, [follow **@docusaurus** on Twitter](https://twitter.com/docusaurus) and the [official Docusaurus blog](/blog) on this website. diff --git a/website/community/team.mdx b/website/community/team.mdx index aab7ae51a5..31d0a30b88 100644 --- a/website/community/team.mdx +++ b/website/community/team.mdx @@ -10,7 +10,7 @@ import { StudentFellowsTeamRow, } from '@site/src/components/TeamProfileCards'; -## Active Team +## Active Team {#active-team} The Docusaurus team works on the core functionality, plugins for the classic theme, as well as the Docusaurus documentation website. @@ -18,19 +18,19 @@ Current members of the Docusaurus team are listed in alphabetical order below. -## Honorary Alumni +## Honorary Alumni {#honorary-alumni} Docusaurus would never be what it is today without the huge contributions from these folks who have moved on to bigger and greater things. -## Student Fellows +## Student Fellows {#student-fellows} 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. -## Acknowledgements +## Acknowledgements {#acknowledgements} 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: diff --git a/website/docs/api/docusaurus.config.js.md b/website/docs/api/docusaurus.config.js.md index fcdc89450b..0bafdc54f1 100644 --- a/website/docs/api/docusaurus.config.js.md +++ b/website/docs/api/docusaurus.config.js.md @@ -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} @@ -285,7 +285,7 @@ module.exports = { }; ``` -### `themes` +### `themes` {#themes} @@ -297,7 +297,7 @@ module.exports = { }; ``` -### `presets` +### `presets` {#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 `