From 6c1ba6ff17c65ff24cfb3db353d0d06bf5f676dd Mon Sep 17 00:00:00 2001 From: sebastien Date: Fri, 6 Feb 2026 19:07:59 +0100 Subject: [PATCH] fix readme consistency --- packages/docusaurus-remark-plugin-npm2yarn/README.md | 2 +- packages/docusaurus-theme-classic/README.md | 2 +- packages/docusaurus-theme-live-codeblock/README.md | 2 +- packages/docusaurus-theme-mermaid/README.md | 2 +- packages/docusaurus-theme-translations/README.md | 2 +- packages/docusaurus-tsconfig/README.md | 3 +++ packages/docusaurus-tsconfig/package.json | 2 +- packages/docusaurus-utils-common/README.md | 2 +- packages/docusaurus/README.md | 4 +++- 9 files changed, 13 insertions(+), 8 deletions(-) create mode 100644 packages/docusaurus-tsconfig/README.md diff --git a/packages/docusaurus-remark-plugin-npm2yarn/README.md b/packages/docusaurus-remark-plugin-npm2yarn/README.md index eee65efa046d..22681d08c5da 100644 --- a/packages/docusaurus-remark-plugin-npm2yarn/README.md +++ b/packages/docusaurus-remark-plugin-npm2yarn/README.md @@ -1,4 +1,4 @@ -# Remark plugin npm2yarn +# `@docusaurus/remark-plugin-npm2yarn` ## Motivation: diff --git a/packages/docusaurus-theme-classic/README.md b/packages/docusaurus-theme-classic/README.md index 3a30bb92903e..0b15395d5027 100644 --- a/packages/docusaurus-theme-classic/README.md +++ b/packages/docusaurus-theme-classic/README.md @@ -1,4 +1,4 @@ -# Docusaurus Theme Classic +# `@docusaurus/theme-classic` The classic theme for Docusaurus. diff --git a/packages/docusaurus-theme-live-codeblock/README.md b/packages/docusaurus-theme-live-codeblock/README.md index 1f31661ec9fd..946273b40d34 100644 --- a/packages/docusaurus-theme-live-codeblock/README.md +++ b/packages/docusaurus-theme-live-codeblock/README.md @@ -1,4 +1,4 @@ -# Docusaurus Live Codeblock +# `@docusaurus/theme-live-codeblock` You can create live code editors with a code block `live` meta string. diff --git a/packages/docusaurus-theme-mermaid/README.md b/packages/docusaurus-theme-mermaid/README.md index ec903286aad8..ba03756e1f9b 100644 --- a/packages/docusaurus-theme-mermaid/README.md +++ b/packages/docusaurus-theme-mermaid/README.md @@ -1,4 +1,4 @@ -# Docusaurus Theme Mermaid +# `@docusaurus/theme-mermaid` The mermaid components for Docusaurus. diff --git a/packages/docusaurus-theme-translations/README.md b/packages/docusaurus-theme-translations/README.md index 0878bf0350ff..89edba93db8c 100644 --- a/packages/docusaurus-theme-translations/README.md +++ b/packages/docusaurus-theme-translations/README.md @@ -1,4 +1,4 @@ -# Docusaurus theme translations +# `@docusaurus/theme-translations` This package includes default translations for labels (like the pagination "Next" / "Previous") used by official Docusaurus themes. diff --git a/packages/docusaurus-tsconfig/README.md b/packages/docusaurus-tsconfig/README.md new file mode 100644 index 000000000000..751e513869b9 --- /dev/null +++ b/packages/docusaurus-tsconfig/README.md @@ -0,0 +1,3 @@ +# `@docusaurus/tsconfig` + +Base TypeScript configuration for Docusaurus websites diff --git a/packages/docusaurus-tsconfig/package.json b/packages/docusaurus-tsconfig/package.json index d27329772567..1313795c6abf 100644 --- a/packages/docusaurus-tsconfig/package.json +++ b/packages/docusaurus-tsconfig/package.json @@ -1,7 +1,7 @@ { "name": "@docusaurus/tsconfig", "version": "3.9.2", - "description": "Docusaurus base TypeScript configuration.", + "description": "Base TypeScript configuration for Docusaurus websites", "main": "tsconfig.json", "publishConfig": { "access": "public" diff --git a/packages/docusaurus-utils-common/README.md b/packages/docusaurus-utils-common/README.md index 9f4a6db4d136..38a016c789c6 100644 --- a/packages/docusaurus-utils-common/README.md +++ b/packages/docusaurus-utils-common/README.md @@ -1,3 +1,3 @@ -# `@docusaurus/utils` +# `@docusaurus/utils-common` Common (Node/Browser) utility functions for Docusaurus packages. diff --git a/packages/docusaurus/README.md b/packages/docusaurus/README.md index d86354231163..6a0522383665 100644 --- a/packages/docusaurus/README.md +++ b/packages/docusaurus/README.md @@ -1 +1,3 @@ -# Docusaurus core +# `@docusaurus/core` + +The core package of Docusaurus