From 71705d4956b37e834e0c811e75b22c0085dccc01 Mon Sep 17 00:00:00 2001 From: boot-190 <116923812+boot-190@users.noreply.github.com> Date: Sat, 29 Oct 2022 17:56:40 -0500 Subject: [PATCH] Revert "docs: remove useless front matter (#7518)" This reverts commit ab566ecce3a1c722bfeef26901a7a1f951179801. --- website/docs/api/docusaurus.config.js.md | 1 + website/docs/api/misc/create-docusaurus.md | 5 ++--- website/docs/api/misc/eslint-plugin/README.md | 6 +++--- .../docs/api/misc/eslint-plugin/no-untranslated-text.md | 4 +--- .../misc/eslint-plugin/string-literal-i18n-messages.md | 2 +- website/docs/api/misc/logger/logger.md | 5 ++--- website/docs/api/plugins/overview.md | 5 ++--- website/docs/api/plugins/plugin-client-redirects.md | 6 +++--- website/docs/api/plugins/plugin-content-blog.md | 6 +++--- website/docs/api/plugins/plugin-content-docs.md | 6 +++--- website/docs/api/plugins/plugin-content-pages.md | 6 +++--- website/docs/api/plugins/plugin-debug.md | 6 +++--- website/docs/api/plugins/plugin-google-analytics.md | 6 +++--- website/docs/api/plugins/plugin-google-gtag.md | 6 +++--- website/docs/api/plugins/plugin-ideal-image.md | 6 +++--- website/docs/api/plugins/plugin-pwa.md | 6 +++--- website/docs/api/plugins/plugin-sitemap.md | 6 +++--- website/docs/api/themes/overview.md | 5 ++--- website/docs/api/themes/theme-classic.md | 6 +++--- website/docs/api/themes/theme-configuration.md | 8 ++++---- website/docs/api/themes/theme-live-codeblock.md | 6 +++--- website/docs/api/themes/theme-search-algolia.md | 6 +++--- website/docs/blog.mdx | 7 +++---- website/docs/browser-support.md | 5 ++--- website/docs/cli.md | 2 +- website/docs/configuration.md | 5 ++--- website/docs/deployment.mdx | 5 ++--- website/docs/docusaurus-core.md | 4 ++-- website/docs/guides/creating-pages.md | 4 ++-- website/docs/guides/docs/docs-create-doc.mdx | 3 +-- website/docs/guides/docs/docs-introduction.md | 3 +-- website/docs/guides/docs/docs-multi-instance.mdx | 3 +-- website/docs/guides/docs/versioning.md | 8 ++++---- .../markdown-features/markdown-features-admonitions.mdx | 3 +-- .../markdown-features/markdown-features-assets.mdx | 3 +-- .../markdown-features/markdown-features-code-blocks.mdx | 3 +-- .../markdown-features-head-metadata.mdx | 1 + .../guides/markdown-features/markdown-features-intro.mdx | 4 ++-- .../markdown-features-math-equations.mdx | 3 +-- .../markdown-features/markdown-features-plugins.mdx | 3 +-- .../guides/markdown-features/markdown-features-react.mdx | 1 + .../guides/markdown-features/markdown-features-tabs.mdx | 3 +-- website/docs/i18n/i18n-crowdin.mdx | 3 +-- website/docs/i18n/i18n-git.md | 3 +-- website/docs/i18n/i18n-introduction.md | 3 +-- website/docs/i18n/i18n-tutorial.md | 4 +--- website/docs/installation.md | 5 ++--- website/docs/introduction.md | 4 ++-- website/docs/migration/migration-automated.md | 4 ++-- website/docs/migration/migration-manual.md | 4 ++-- website/docs/migration/migration-overview.md | 4 ++-- website/docs/migration/migration-translated-sites.md | 4 ++-- website/docs/migration/migration-versioned-sites.md | 4 ++-- website/docs/search.md | 4 ++-- website/docs/seo.md | 5 ++--- website/docs/static-assets.md | 9 ++++----- website/docs/styling-layout.md | 4 ++-- website/docs/typescript-support.md | 5 ++--- 58 files changed, 118 insertions(+), 143 deletions(-) diff --git a/website/docs/api/docusaurus.config.js.md b/website/docs/api/docusaurus.config.js.md index cb5e93a8fde5..6d6b6fb433c6 100644 --- a/website/docs/api/docusaurus.config.js.md +++ b/website/docs/api/docusaurus.config.js.md @@ -1,5 +1,6 @@ --- sidebar_position: 0 +id: docusaurus.config.js description: API reference for Docusaurus configuration file. slug: /api/docusaurus-config --- diff --git a/website/docs/api/misc/create-docusaurus.md b/website/docs/api/misc/create-docusaurus.md index b4dc0491e4a8..e35d3884cd78 100644 --- a/website/docs/api/misc/create-docusaurus.md +++ b/website/docs/api/misc/create-docusaurus.md @@ -1,10 +1,9 @@ --- sidebar_position: 0 -slug: /api/misc/create-docusaurus +title: '📦 create-docusaurus' +slug: '/api/misc/create-docusaurus' --- -# 📦 create-docusaurus - A scaffolding utility to help you instantly set up a functional Docusaurus app. ## Usage {#usage} diff --git a/website/docs/api/misc/eslint-plugin/README.md b/website/docs/api/misc/eslint-plugin/README.md index 9d0d2236846c..8519bcfe6ef1 100644 --- a/website/docs/api/misc/eslint-plugin/README.md +++ b/website/docs/api/misc/eslint-plugin/README.md @@ -1,10 +1,10 @@ --- sidebar_position: 1 -slug: /api/misc/@docusaurus/eslint-plugin +id: eslint-plugin +title: '📦 eslint-plugin' +slug: '/api/misc/@docusaurus/eslint-plugin' --- -# 📦 eslint-plugin - [ESLint](https://eslint.org/) is a tool that statically analyzes your code and reports problems or suggests best practices through editor hints and command line. Docusaurus provides an ESLint plugin to enforce best Docusaurus practices. ## Installation diff --git a/website/docs/api/misc/eslint-plugin/no-untranslated-text.md b/website/docs/api/misc/eslint-plugin/no-untranslated-text.md index 3829a915bad9..6807a51f480c 100644 --- a/website/docs/api/misc/eslint-plugin/no-untranslated-text.md +++ b/website/docs/api/misc/eslint-plugin/no-untranslated-text.md @@ -1,11 +1,9 @@ --- -slug: /api/misc/@docusaurus/eslint-plugin/no-untranslated-text +slug: '/api/misc/@docusaurus/eslint-plugin/no-untranslated-text' --- # no-untranslated-text -import APITable from '@site/src/components/APITable'; - Enforce text labels in JSX to be wrapped by translate calls. When the [i18n feature](../../../i18n/i18n-introduction.md) is used, this rule ensures that all labels appearing on the website are translatable, so no string accidentally slips through untranslated. diff --git a/website/docs/api/misc/eslint-plugin/string-literal-i18n-messages.md b/website/docs/api/misc/eslint-plugin/string-literal-i18n-messages.md index c216b78233a9..9829a4d89bf7 100644 --- a/website/docs/api/misc/eslint-plugin/string-literal-i18n-messages.md +++ b/website/docs/api/misc/eslint-plugin/string-literal-i18n-messages.md @@ -1,5 +1,5 @@ --- -slug: /api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages +slug: '/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages' --- # string-literal-i18n-messages diff --git a/website/docs/api/misc/logger/logger.md b/website/docs/api/misc/logger/logger.md index 04800ed25b78..d4d56e6f699b 100644 --- a/website/docs/api/misc/logger/logger.md +++ b/website/docs/api/misc/logger/logger.md @@ -1,10 +1,9 @@ --- sidebar_position: 2 -slug: /api/misc/@docusaurus/logger +title: '📦 logger' +slug: '/api/misc/@docusaurus/logger' --- -# 📦 logger - An encapsulated logger for semantically formatting console messages. Authors of packages in the Docusaurus ecosystem are encouraged to use this package to provide unified log formats. diff --git a/website/docs/api/plugins/overview.md b/website/docs/api/plugins/overview.md index f1d1656aa38c..31897e73e682 100644 --- a/website/docs/api/plugins/overview.md +++ b/website/docs/api/plugins/overview.md @@ -1,12 +1,11 @@ --- sidebar_position: 0 id: plugins-overview +title: 'Docusaurus plugins' sidebar_label: Plugins overview -slug: /api/plugins +slug: '/api/plugins' --- -# Docusaurus plugins - We provide official Docusaurus plugins. ## Content plugins {#content-plugins} diff --git a/website/docs/api/plugins/plugin-client-redirects.md b/website/docs/api/plugins/plugin-client-redirects.md index a24ac3e24b84..7892ad9f6ca5 100644 --- a/website/docs/api/plugins/plugin-client-redirects.md +++ b/website/docs/api/plugins/plugin-client-redirects.md @@ -1,10 +1,10 @@ --- sidebar_position: 4 -slug: /api/plugins/@docusaurus/plugin-client-redirects +id: plugin-client-redirects +title: '📦 plugin-client-redirects' +slug: '/api/plugins/@docusaurus/plugin-client-redirects' --- -# 📦 plugin-client-redirects - import APITable from '@site/src/components/APITable'; Docusaurus Plugin to generate **client-side redirects**. diff --git a/website/docs/api/plugins/plugin-content-blog.md b/website/docs/api/plugins/plugin-content-blog.md index 696b4102858d..d87f3158afb1 100644 --- a/website/docs/api/plugins/plugin-content-blog.md +++ b/website/docs/api/plugins/plugin-content-blog.md @@ -1,10 +1,10 @@ --- sidebar_position: 2 -slug: /api/plugins/@docusaurus/plugin-content-blog +id: plugin-content-blog +title: '📦 plugin-content-blog' +slug: '/api/plugins/@docusaurus/plugin-content-blog' --- -# 📦 plugin-content-blog - import APITable from '@site/src/components/APITable'; Provides the [Blog](blog.mdx) feature and is the default blog plugin for Docusaurus. diff --git a/website/docs/api/plugins/plugin-content-docs.md b/website/docs/api/plugins/plugin-content-docs.md index 23039d7f3178..81aad1cf1aaa 100644 --- a/website/docs/api/plugins/plugin-content-docs.md +++ b/website/docs/api/plugins/plugin-content-docs.md @@ -1,10 +1,10 @@ --- sidebar_position: 1 -slug: /api/plugins/@docusaurus/plugin-content-docs +id: plugin-content-docs +title: '📦 plugin-content-docs' +slug: '/api/plugins/@docusaurus/plugin-content-docs' --- -# 📦 plugin-content-docs - import APITable from '@site/src/components/APITable'; Provides the [Docs](../../guides/docs/docs-introduction.md) functionality and is the default docs plugin for Docusaurus. diff --git a/website/docs/api/plugins/plugin-content-pages.md b/website/docs/api/plugins/plugin-content-pages.md index b6334f5af7ca..a4f25ec1b669 100644 --- a/website/docs/api/plugins/plugin-content-pages.md +++ b/website/docs/api/plugins/plugin-content-pages.md @@ -1,10 +1,10 @@ --- sidebar_position: 3 -slug: /api/plugins/@docusaurus/plugin-content-pages +id: plugin-content-pages +title: '📦 plugin-content-pages' +slug: '/api/plugins/@docusaurus/plugin-content-pages' --- -# 📦 plugin-content-pages - import APITable from '@site/src/components/APITable'; 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. diff --git a/website/docs/api/plugins/plugin-debug.md b/website/docs/api/plugins/plugin-debug.md index bca9ac69192e..d2b78827f844 100644 --- a/website/docs/api/plugins/plugin-debug.md +++ b/website/docs/api/plugins/plugin-debug.md @@ -1,10 +1,10 @@ --- sidebar_position: 5 -slug: /api/plugins/@docusaurus/plugin-debug +id: plugin-debug +title: '📦 plugin-debug' +slug: '/api/plugins/@docusaurus/plugin-debug' --- -# 📦 plugin-debug - ```mdx-code-block import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/website/docs/api/plugins/plugin-google-analytics.md b/website/docs/api/plugins/plugin-google-analytics.md index 1426e6265a1c..af27b96c093e 100644 --- a/website/docs/api/plugins/plugin-google-analytics.md +++ b/website/docs/api/plugins/plugin-google-analytics.md @@ -1,10 +1,10 @@ --- sidebar_position: 6 -slug: /api/plugins/@docusaurus/plugin-google-analytics +id: plugin-google-analytics +title: '📦 plugin-google-analytics' +slug: '/api/plugins/@docusaurus/plugin-google-analytics' --- -# 📦 plugin-google-analytics - import APITable from '@site/src/components/APITable'; 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 **in the production build**. If you are using Google Analytics 4 you might need to consider using [plugin-google-gtag](./plugin-google-gtag.md) instead. diff --git a/website/docs/api/plugins/plugin-google-gtag.md b/website/docs/api/plugins/plugin-google-gtag.md index db414c4d0f21..e5540ac265eb 100644 --- a/website/docs/api/plugins/plugin-google-gtag.md +++ b/website/docs/api/plugins/plugin-google-gtag.md @@ -1,10 +1,10 @@ --- sidebar_position: 7 -slug: /api/plugins/@docusaurus/plugin-google-gtag +id: plugin-google-gtag +title: '📦 plugin-google-gtag' +slug: '/api/plugins/@docusaurus/plugin-google-gtag' --- -# 📦 plugin-google-gtag - import APITable from '@site/src/components/APITable'; 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. diff --git a/website/docs/api/plugins/plugin-ideal-image.md b/website/docs/api/plugins/plugin-ideal-image.md index e682c3943a75..c824a707dbad 100644 --- a/website/docs/api/plugins/plugin-ideal-image.md +++ b/website/docs/api/plugins/plugin-ideal-image.md @@ -1,10 +1,10 @@ --- sidebar_position: 8 -slug: /api/plugins/@docusaurus/plugin-ideal-image +id: plugin-ideal-image +title: '📦 plugin-ideal-image' +slug: '/api/plugins/@docusaurus/plugin-ideal-image' --- -# 📦 plugin-ideal-image - import APITable from '@site/src/components/APITable'; Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder). diff --git a/website/docs/api/plugins/plugin-pwa.md b/website/docs/api/plugins/plugin-pwa.md index 7aead89fbeed..cbcaa3d4947d 100644 --- a/website/docs/api/plugins/plugin-pwa.md +++ b/website/docs/api/plugins/plugin-pwa.md @@ -1,10 +1,10 @@ --- sidebar_position: 9 -slug: /api/plugins/@docusaurus/plugin-pwa +id: plugin-pwa +title: '📦 plugin-pwa' +slug: '/api/plugins/@docusaurus/plugin-pwa' --- -# 📦 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} diff --git a/website/docs/api/plugins/plugin-sitemap.md b/website/docs/api/plugins/plugin-sitemap.md index 5bfdc50f2b18..ed4b8eab2634 100644 --- a/website/docs/api/plugins/plugin-sitemap.md +++ b/website/docs/api/plugins/plugin-sitemap.md @@ -1,10 +1,10 @@ --- sidebar_position: 10 -slug: /api/plugins/@docusaurus/plugin-sitemap +id: plugin-sitemap +title: '📦 plugin-sitemap' +slug: '/api/plugins/@docusaurus/plugin-sitemap' --- -# 📦 plugin-sitemap - import APITable from '@site/src/components/APITable'; This plugin creates sitemaps for your site so that search engine crawlers can crawl your site more accurately. diff --git a/website/docs/api/themes/overview.md b/website/docs/api/themes/overview.md index f16eff35b511..6047040db0d7 100644 --- a/website/docs/api/themes/overview.md +++ b/website/docs/api/themes/overview.md @@ -1,12 +1,11 @@ --- sidebar_position: 0 id: themes-overview +title: 'Docusaurus themes' sidebar_label: Themes overview -slug: /api/themes +slug: '/api/themes' --- -# Docusaurus themes - We provide official Docusaurus themes. ## Main themes {#main-themes} diff --git a/website/docs/api/themes/theme-classic.md b/website/docs/api/themes/theme-classic.md index cba54b875aeb..a123a5d6ec16 100644 --- a/website/docs/api/themes/theme-classic.md +++ b/website/docs/api/themes/theme-classic.md @@ -1,10 +1,10 @@ --- sidebar_position: 2 -slug: /api/themes/@docusaurus/theme-classic +id: theme-classic +title: '📦 theme-classic' +slug: '/api/themes/@docusaurus/theme-classic' --- -# 📦 theme-classic - The classic theme for Docusaurus. You can refer to the [theme configuration page](theme-configuration.md) for more details on the configuration. diff --git a/website/docs/api/themes/theme-configuration.md b/website/docs/api/themes/theme-configuration.md index 5ad039269351..7440cf592903 100644 --- a/website/docs/api/themes/theme-configuration.md +++ b/website/docs/api/themes/theme-configuration.md @@ -1,12 +1,12 @@ --- sidebar_position: 1 -sidebar_label: Configuration -slug: /api/themes/configuration +id: theme-configuration +title: 'Theme configuration' +sidebar_label: 'Configuration' +slug: '/api/themes/configuration' toc_max_heading_level: 4 --- -# Theme configuration - import APITable from '@site/src/components/APITable'; This configuration applies to all [main themes](./overview.md). diff --git a/website/docs/api/themes/theme-live-codeblock.md b/website/docs/api/themes/theme-live-codeblock.md index be6f4da721d7..75e803499e54 100644 --- a/website/docs/api/themes/theme-live-codeblock.md +++ b/website/docs/api/themes/theme-live-codeblock.md @@ -1,10 +1,10 @@ --- sidebar_position: 3 -slug: /api/themes/@docusaurus/theme-live-codeblock +id: theme-live-codeblock +title: '📦 theme-live-codeblock' +slug: '/api/themes/@docusaurus/theme-live-codeblock' --- -# 📦 theme-live-codeblock - This theme provides a `@theme/CodeBlock` component that is powered by react-live. You can read more on [interactive code editor](../../guides/markdown-features/markdown-features-code-blocks.mdx#interactive-code-editor) documentation. ```bash npm2yarn diff --git a/website/docs/api/themes/theme-search-algolia.md b/website/docs/api/themes/theme-search-algolia.md index a7dd47d2a054..efe20ef82ab9 100644 --- a/website/docs/api/themes/theme-search-algolia.md +++ b/website/docs/api/themes/theme-search-algolia.md @@ -1,10 +1,10 @@ --- sidebar_position: 4 -slug: /api/themes/@docusaurus/theme-search-algolia +id: theme-search-algolia +title: '📦 theme-search-algolia' +slug: '/api/themes/@docusaurus/theme-search-algolia' --- -# 📦 theme-search-algolia - This theme provides a `@theme/SearchBar` component that integrates with Algolia DocSearch easily. Combined with `@docusaurus/theme-classic`, it provides a very easy search integration. You can read more on [search](../../search.md) documentation. ```bash npm2yarn diff --git a/website/docs/blog.mdx b/website/docs/blog.mdx index 780a07dbca87..3e18f956a086 100644 --- a/website/docs/blog.mdx +++ b/website/docs/blog.mdx @@ -1,13 +1,12 @@ --- -description: Deploy a full-featured blog in no time with Docusaurus. +id: blog +title: Blog --- -# Blog - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -The blog feature enables you to deploy a full-featured blog in no time. +The blog feature enables you to deploy in no time a full-featured blog. :::info diff --git a/website/docs/browser-support.md b/website/docs/browser-support.md index 404601d8f45e..4bb2a4dcfe71 100644 --- a/website/docs/browser-support.md +++ b/website/docs/browser-support.md @@ -1,9 +1,8 @@ --- -description: How to keep a reasonable bundle size while ensuring sufficient browser support. +id: browser-support +title: Browser support --- -# Browser support - Docusaurus allows sites to define the list of supported browsers through a [browserslist configuration](https://github.com/browserslist/browserslist). ## Purpose {#purpose} diff --git a/website/docs/cli.md b/website/docs/cli.md index 01a3567fa31b..64652cab503f 100644 --- a/website/docs/cli.md +++ b/website/docs/cli.md @@ -1,5 +1,5 @@ --- -description: Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. +id: cli --- # CLI diff --git a/website/docs/configuration.md b/website/docs/configuration.md index eb192c6f9201..36e5cf2736a6 100644 --- a/website/docs/configuration.md +++ b/website/docs/configuration.md @@ -1,9 +1,8 @@ --- -description: Configuring your site's behavior through docusaurus.config.js and more. +id: configuration +title: Configuration --- -# Configuration - import TOCInline from '@theme/TOCInline'; Docusaurus has a unique take on configurations. We encourage you to congregate information about your site into one place. We guard the fields of this file and facilitate making this data object accessible across your site. diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index d285b6447f3b..c2db38c2be80 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -1,9 +1,8 @@ --- -description: Deploy your Docusaurus app for production on a range of static site hosting services. +id: deployment +title: Deployment --- -# Deployment - To build the static files of your website for production, run: ```bash npm2yarn diff --git a/website/docs/docusaurus-core.md b/website/docs/docusaurus-core.md index ee932f0eed6e..6a9d934dcd4e 100644 --- a/website/docs/docusaurus-core.md +++ b/website/docs/docusaurus-core.md @@ -1,9 +1,9 @@ --- +id: docusaurus-core +title: Docusaurus Client API sidebar_label: Client API --- -# Docusaurus Client API - Docusaurus provides some APIs on the clients that can be helpful to you when building your site. ## Components {#components} diff --git a/website/docs/guides/creating-pages.md b/website/docs/guides/creating-pages.md index fbc89e20d6ce..a5ddaa304b9b 100644 --- a/website/docs/guides/creating-pages.md +++ b/website/docs/guides/creating-pages.md @@ -1,10 +1,10 @@ --- +id: creating-pages +title: Creating Pages slug: /creating-pages sidebar_label: Pages --- -# Creating Pages - In this section, we will learn about creating pages in Docusaurus. The `@docusaurus/plugin-content-pages` plugin empowers you to create **one-off standalone pages** like a showcase page, playground page, or support page. You can use React components, or Markdown. diff --git a/website/docs/guides/docs/docs-create-doc.mdx b/website/docs/guides/docs/docs-create-doc.mdx index 5221a2a0e37d..fc14144609f0 100644 --- a/website/docs/guides/docs/docs-create-doc.mdx +++ b/website/docs/guides/docs/docs-create-doc.mdx @@ -1,11 +1,10 @@ --- id: create-doc +title: Create a doc description: Create a Markdown Document slug: /create-doc --- -# Create a doc - Create a Markdown file, `greeting.md`, and place it under the `docs` directory. ```bash diff --git a/website/docs/guides/docs/docs-introduction.md b/website/docs/guides/docs/docs-introduction.md index 7aa09d0dd05b..4cd262f94e57 100644 --- a/website/docs/guides/docs/docs-introduction.md +++ b/website/docs/guides/docs/docs-introduction.md @@ -1,11 +1,10 @@ --- id: introduction +title: Docs Introduction sidebar_label: Introduction slug: /docs-introduction --- -# Docs Introduction - The docs feature provides users with a way to organize Markdown files in a hierarchical format. :::info diff --git a/website/docs/guides/docs/docs-multi-instance.mdx b/website/docs/guides/docs/docs-multi-instance.mdx index 69a1a1656ce2..fef2e98ae04e 100644 --- a/website/docs/guides/docs/docs-multi-instance.mdx +++ b/website/docs/guides/docs/docs-multi-instance.mdx @@ -1,11 +1,10 @@ --- id: multi-instance +title: Docs Multi-instance description: Use multiple docs plugin instances on a single Docusaurus site. slug: /docs-multi-instance --- -# Docs Multi-instance - The `@docusaurus/plugin-content-docs` plugin can support [multi-instance](../../using-plugins.md#multi-instance-plugins-and-plugin-ids). :::note diff --git a/website/docs/guides/docs/versioning.md b/website/docs/guides/docs/versioning.md index d2b3cd4f0a34..aae5eb7b3f13 100644 --- a/website/docs/guides/docs/versioning.md +++ b/website/docs/guides/docs/versioning.md @@ -1,16 +1,16 @@ --- +id: versioning +title: Versioning slug: /versioning --- -# Versioning - -You can use the versioning CLI to create a new documentation version based on the latest content in the `docs` directory. That specific set of documentation will then be preserved and accessible even as the documentation in the `docs` directory continues to evolve. - ```mdx-code-block import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ``` +You can use the version script to create a new documentation version based on the latest content in the `docs` directory. That specific set of documentation will then be preserved and accessible even as the documentation in the `docs` directory changes moving forward. + :::caution Think about it before starting to version your documentation - it can become difficult for contributors to help improve it! diff --git a/website/docs/guides/markdown-features/markdown-features-admonitions.mdx b/website/docs/guides/markdown-features/markdown-features-admonitions.mdx index f76ec875f7b0..c0fb4c7448d1 100644 --- a/website/docs/guides/markdown-features/markdown-features-admonitions.mdx +++ b/website/docs/guides/markdown-features/markdown-features-admonitions.mdx @@ -1,11 +1,10 @@ --- id: admonitions +title: Admonitions description: Handling admonitions/callouts in Docusaurus Markdown slug: /markdown-features/admonitions --- -# Admonitions - import BrowserWindow from '@site/src/components/BrowserWindow'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/website/docs/guides/markdown-features/markdown-features-assets.mdx b/website/docs/guides/markdown-features/markdown-features-assets.mdx index 58c875c810ef..ed0f4aed8b87 100644 --- a/website/docs/guides/markdown-features/markdown-features-assets.mdx +++ b/website/docs/guides/markdown-features/markdown-features-assets.mdx @@ -1,11 +1,10 @@ --- id: assets +title: Assets description: Handling assets in Docusaurus Markdown slug: /markdown-features/assets --- -# Assets - import BrowserWindow from '@site/src/components/BrowserWindow'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/website/docs/guides/markdown-features/markdown-features-code-blocks.mdx b/website/docs/guides/markdown-features/markdown-features-code-blocks.mdx index 99669971e064..3aeeb9da883f 100644 --- a/website/docs/guides/markdown-features/markdown-features-code-blocks.mdx +++ b/website/docs/guides/markdown-features/markdown-features-code-blocks.mdx @@ -1,11 +1,10 @@ --- id: code-blocks +title: Code blocks description: Handling code blocks in Docusaurus Markdown slug: /markdown-features/code-blocks --- -# Code blocks - import BrowserWindow from '@site/src/components/BrowserWindow'; import CodeBlock from '@theme/CodeBlock'; diff --git a/website/docs/guides/markdown-features/markdown-features-head-metadata.mdx b/website/docs/guides/markdown-features/markdown-features-head-metadata.mdx index 8d4669505bf9..66fd5748c5e9 100644 --- a/website/docs/guides/markdown-features/markdown-features-head-metadata.mdx +++ b/website/docs/guides/markdown-features/markdown-features-head-metadata.mdx @@ -1,5 +1,6 @@ --- id: head-metadata +title: Head Metadata description: Declaring page-specific head metadata through MDX slug: /markdown-features/head-metadata --- diff --git a/website/docs/guides/markdown-features/markdown-features-intro.mdx b/website/docs/guides/markdown-features/markdown-features-intro.mdx index 7b56a3765057..381d75d7c5c8 100644 --- a/website/docs/guides/markdown-features/markdown-features-intro.mdx +++ b/website/docs/guides/markdown-features/markdown-features-intro.mdx @@ -1,11 +1,11 @@ --- id: introduction +title: Markdown Features +sidebar_label: Introduction description: Docusaurus uses MDX. Find out more about Docusaurus-specific features when writing Markdown. slug: /markdown-features --- -# Markdown Features - import BrowserWindow from '@site/src/components/BrowserWindow'; Documentation is one of your product's interfaces with your users. A well-written and well-organized set of docs helps your users understand your product quickly. Our aligned goal here is to help your users find and understand the information they need, as quickly as possible. diff --git a/website/docs/guides/markdown-features/markdown-features-math-equations.mdx b/website/docs/guides/markdown-features/markdown-features-math-equations.mdx index 631a9dbaa5d3..0084a602d287 100644 --- a/website/docs/guides/markdown-features/markdown-features-math-equations.mdx +++ b/website/docs/guides/markdown-features/markdown-features-math-equations.mdx @@ -1,11 +1,10 @@ --- id: math-equations +title: Math Equations description: Writing LaTeX Math Equations slug: /markdown-features/math-equations --- -# Math Equations - import BrowserWindow from '@site/src/components/BrowserWindow'; Mathematical equations can be rendered using [KaTeX](https://katex.org). diff --git a/website/docs/guides/markdown-features/markdown-features-plugins.mdx b/website/docs/guides/markdown-features/markdown-features-plugins.mdx index 50e6d37a6d4c..b3a6d59b5627 100644 --- a/website/docs/guides/markdown-features/markdown-features-plugins.mdx +++ b/website/docs/guides/markdown-features/markdown-features-plugins.mdx @@ -1,11 +1,10 @@ --- id: plugins +title: MDX Plugins description: Using MDX plugins to expand Docusaurus Markdown functionalities slug: /markdown-features/plugins --- -# MDX Plugins - Sometimes, you may want to extend or tweak your Markdown syntax. For example: - How do I embed youtube videos using the image syntax (`![](https://youtu.be/yKNxeF4KMsY)`)? diff --git a/website/docs/guides/markdown-features/markdown-features-react.mdx b/website/docs/guides/markdown-features/markdown-features-react.mdx index 9d030c84d960..60817f63a00d 100644 --- a/website/docs/guides/markdown-features/markdown-features-react.mdx +++ b/website/docs/guides/markdown-features/markdown-features-react.mdx @@ -1,5 +1,6 @@ --- id: react +title: MDX and React description: Using the power of React in Docusaurus Markdown documents, thanks to MDX slug: /markdown-features/react --- diff --git a/website/docs/guides/markdown-features/markdown-features-tabs.mdx b/website/docs/guides/markdown-features/markdown-features-tabs.mdx index 897f54a8a7c0..40987d28e479 100644 --- a/website/docs/guides/markdown-features/markdown-features-tabs.mdx +++ b/website/docs/guides/markdown-features/markdown-features-tabs.mdx @@ -1,11 +1,10 @@ --- id: tabs +title: Tabs description: Using tabs inside Docusaurus Markdown slug: /markdown-features/tabs --- -# Tabs - ```mdx-code-block import BrowserWindow from '@site/src/components/BrowserWindow'; import Tabs from '@theme/Tabs'; diff --git a/website/docs/i18n/i18n-crowdin.mdx b/website/docs/i18n/i18n-crowdin.mdx index 14b2765f2b28..3e8686d5e0d3 100644 --- a/website/docs/i18n/i18n-crowdin.mdx +++ b/website/docs/i18n/i18n-crowdin.mdx @@ -1,11 +1,10 @@ --- id: crowdin +title: i18n - Using Crowdin slug: /i18n/crowdin toc_max_heading_level: 4 --- -# i18n - Using Crowdin - The i18n system of Docusaurus is **decoupled from any translation software**. You can integrate Docusaurus with the **tools and SaaS of your choice**, as long as you put the **translation files at the correct location**. diff --git a/website/docs/i18n/i18n-git.md b/website/docs/i18n/i18n-git.md index 18f3094aa262..12c8f157995f 100644 --- a/website/docs/i18n/i18n-git.md +++ b/website/docs/i18n/i18n-git.md @@ -1,10 +1,9 @@ --- id: git +title: i18n - Using git slug: /i18n/git --- -# i18n - Using git - A **possible translation strategy** is to **version control the translation files** with Git (or any other [VCS](https://en.wikipedia.org/wiki/Version_control)). ## Tradeoffs {#tradeoffs} diff --git a/website/docs/i18n/i18n-introduction.md b/website/docs/i18n/i18n-introduction.md index 3cfa077af6f2..610e8304175d 100644 --- a/website/docs/i18n/i18n-introduction.md +++ b/website/docs/i18n/i18n-introduction.md @@ -1,10 +1,9 @@ --- id: introduction +title: i18n - Introduction slug: /i18n/introduction --- -# i18n - Introduction - It is **easy to translate a Docusaurus website** with its internationalization ([i18n](https://en.wikipedia.org/wiki/Internationalization_and_localization)) support. ## Goals {#goals} diff --git a/website/docs/i18n/i18n-tutorial.md b/website/docs/i18n/i18n-tutorial.md index 8e621b2810d1..c325df143356 100644 --- a/website/docs/i18n/i18n-tutorial.md +++ b/website/docs/i18n/i18n-tutorial.md @@ -1,11 +1,9 @@ --- id: tutorial -description: This tutorial will walk you through the basics of the Docusaurus i18n system. +title: i18n - Tutorial slug: /i18n/tutorial --- -# i18n - Tutorial - ```mdx-code-block import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/website/docs/installation.md b/website/docs/installation.md index 442d758f7d18..92576624eec1 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -1,9 +1,8 @@ --- -description: How to install Docusaurus locally, and start a Docusaurus site in no time. +id: installation +title: Installation --- -# Installation - ```mdx-code-block import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/website/docs/introduction.md b/website/docs/introduction.md index 4a0cc82d600b..b91a2c3700e7 100644 --- a/website/docs/introduction.md +++ b/website/docs/introduction.md @@ -1,10 +1,10 @@ --- +id: introduction +title: Introduction description: Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. slug: / --- -# Introduction - ⚡️ Docusaurus will help you ship a **beautiful documentation site in no time**. 💸 Building a custom tech stack is expensive. Instead, **focus on your content** and just write Markdown files. diff --git a/website/docs/migration/migration-automated.md b/website/docs/migration/migration-automated.md index 65f95cfdaf5a..a4422db65d1e 100644 --- a/website/docs/migration/migration-automated.md +++ b/website/docs/migration/migration-automated.md @@ -1,9 +1,9 @@ --- +id: migration-automated +title: Automated migration slug: /migration/automated --- -# Automated migration - The migration CLI automatically migrates your v1 website to a v2 website. :::info diff --git a/website/docs/migration/migration-manual.md b/website/docs/migration/migration-manual.md index 750246954631..78ec6c461a9b 100644 --- a/website/docs/migration/migration-manual.md +++ b/website/docs/migration/migration-manual.md @@ -1,10 +1,10 @@ --- +id: migration-manual +title: Manual migration slug: /migration/manual toc_max_heading_level: 4 --- -# Manual migration - This manual migration process should be run after the [automated migration process](./migration-automated.md), to complete the missing parts, or debug issues in the migration CLI output. ## Project setup {#project-setup} diff --git a/website/docs/migration/migration-overview.md b/website/docs/migration/migration-overview.md index 1c450ea03a57..ec908b5d6243 100644 --- a/website/docs/migration/migration-overview.md +++ b/website/docs/migration/migration-overview.md @@ -1,9 +1,9 @@ --- +id: migration-overview +title: Migration overview slug: /migration --- -# Migration overview - This doc guides you through migrating an existing Docusaurus 1 site to Docusaurus 2. We try to make this as easy as possible, and provide a migration CLI. diff --git a/website/docs/migration/migration-translated-sites.md b/website/docs/migration/migration-translated-sites.md index e8ed65a0d0a4..250a6a208f61 100644 --- a/website/docs/migration/migration-translated-sites.md +++ b/website/docs/migration/migration-translated-sites.md @@ -1,9 +1,9 @@ --- +id: migration-translated-sites +title: Translated sites slug: /migration/translated-sites --- -# Translated sites - This page explains how migrate a translated Docusaurus v1 site to Docusaurus v2. ## i18n differences {#i18n-differences} diff --git a/website/docs/migration/migration-versioned-sites.md b/website/docs/migration/migration-versioned-sites.md index ff9a412271a7..8d03dd9d7304 100644 --- a/website/docs/migration/migration-versioned-sites.md +++ b/website/docs/migration/migration-versioned-sites.md @@ -1,9 +1,9 @@ --- +id: migration-versioned-sites +title: Versioned sites slug: /migration/versioned-sites --- -# Versioned sites - Read up https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2#versioning first for problems in v1's approach. :::note diff --git a/website/docs/search.md b/website/docs/search.md index e00e022cfaca..d3b27ec96cab 100644 --- a/website/docs/search.md +++ b/website/docs/search.md @@ -1,11 +1,11 @@ --- +id: search +title: Search keywords: - algolia - search --- -# Search - There are a few options you can use to add search to your website: - 🥇 [Algolia DocSearch](#using-algolia-docsearch) (**official**) diff --git a/website/docs/seo.md b/website/docs/seo.md index f252889cdf54..aa1259bac57f 100644 --- a/website/docs/seo.md +++ b/website/docs/seo.md @@ -1,13 +1,12 @@ --- -description: How to make your Docusaurus site maximally search-engine-friendly. +id: seo +title: Search engine optimization (SEO) sidebar_label: SEO keywords: - seo - positioning --- -# Search engine optimization (SEO) - import BrowserWindow from '@site/src/components/BrowserWindow'; Docusaurus supports search engine optimization in a variety of ways. diff --git a/website/docs/static-assets.md b/website/docs/static-assets.md index eb9d319b3c87..0b70bb91b092 100644 --- a/website/docs/static-assets.md +++ b/website/docs/static-assets.md @@ -1,12 +1,11 @@ --- -description: Static assets are the non-code files that are directly copied to the build output. Learn about how they are handled and what the best practices of using static assets are. +id: static-assets +title: Static Assets --- -# Static Assets +Every website needs assets: images, stylesheets, favicons, etc. By default, you are suggested to put these assets in the `static` folder. -Static assets are the non-code files that are directly copied to the build output. They include images, stylesheets, favicons, fonts, etc. - -By default, you are suggested to put these assets in the `static` folder. Every file you put into **that directory will be copied** into the root of the generated `build` folder with the directory hierarchy preserved. E.g. if you add a file named `sun.jpg` to the static folder, it will be copied to `build/sun.jpg`. +Every file you put into **that directory will be copied** into the root of the generated `build` folder with the directory hierarchy preserved. E.g. if you add a file named `sun.jpg` to the static folder, it will be copied to `build/sun.jpg`. This means that: diff --git a/website/docs/styling-layout.md b/website/docs/styling-layout.md index b9cee786b711..b6cba21b2e5d 100644 --- a/website/docs/styling-layout.md +++ b/website/docs/styling-layout.md @@ -1,11 +1,11 @@ --- +id: styling-layout +title: Styling and Layout description: A Docusaurus site is a pre-rendered single-page React application. You can style it the way you style React apps. --- import ColorGenerator from '@site/src/components/ColorGenerator'; -# Styling and Layout - :::tip This section is focused on styling through stylesheets. For more advanced customizations (DOM structure, React code...), refer to the [swizzling guide](./swizzling.md). diff --git a/website/docs/typescript-support.md b/website/docs/typescript-support.md index ee494128822f..7be5cb9d1108 100644 --- a/website/docs/typescript-support.md +++ b/website/docs/typescript-support.md @@ -1,9 +1,8 @@ --- -description: Docusaurus is written in TypeScript and provides first-class TypeScript support. +id: typescript-support +title: TypeScript Support --- -# TypeScript Support - Docusaurus is written in TypeScript and provides first-class TypeScript support. ## Initialization {#initialization}