Skip to content

docs: fix package readme consistency #11721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slorber merged 1 commit into from
Feb 6, 2026
+13 −8
Merged

docs: fix package readme consistency #11721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/docusaurus-remark-plugin-npm2yarn/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Remark plugin npm2yarn
# `@docusaurus/remark-plugin-npm2yarn`

## Motivation:

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-classic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Docusaurus Theme Classic
# `@docusaurus/theme-classic`

The classic theme for Docusaurus.

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-live-codeblock/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Docusaurus Live Codeblock
# `@docusaurus/theme-live-codeblock`

You can create live code editors with a code block `live` meta string.

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-mermaid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Docusaurus Theme Mermaid
# `@docusaurus/theme-mermaid`

The mermaid components for Docusaurus.

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-translations/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
3 changes: 3 additions & 0 deletions packages/docusaurus-tsconfig/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `@docusaurus/tsconfig`

Base TypeScript configuration for Docusaurus websites
2 changes: 1 addition & 1 deletion packages/docusaurus-tsconfig/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-utils-common/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# `@docusaurus/utils`
# `@docusaurus/utils-common`

Common (Node/Browser) utility functions for Docusaurus packages.
4 changes: 3 additions & 1 deletion packages/docusaurus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Docusaurus core
# `@docusaurus/core`

The core package of Docusaurus