Skip to content

fix(content-docs): use category index convention to infer document title #8052

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

Draft
MarkShawn2020 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −1
Draft

fix(content-docs): use category index convention to infer document title #8052

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
7 changes: 6 additions & 1 deletion packages/docusaurus-plugin-content-docs/src/docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,12 @@ async function doProcessDocMetadata({
// Note: the title is used by default for page title, sidebar label,
// pagination buttons... frontMatter.title should be used in priority over
// contentTitle (because it can contain markdown/JSX syntax)
const title: string = frontMatter.title ?? contentTitle ?? baseID;
// if filename is `index` or `readme`, then use the parent directory name
const derivedNameFromPath = /^(?:index|readme)$/i.test(baseID)
? path.basename(sourceDirName)
: unprefixedFileName;
const title: string =
frontMatter.title ?? contentTitle ?? derivedNameFromPath;

const description: string = frontMatter.description ?? excerpt ?? '';

Expand Down