Skip to content
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

fix(v2): fix title logic (meta vs heading) + ignore fixed anchor id syntax #4688

Merged
merged 8 commits into from
Apr 27, 2021
Merged

fix(v2): fix title logic (meta vs heading) + ignore fixed anchor id syntax #4688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
aa04be0
parseMarkdownContentTitle should ignore {#my-anchor-id} syntax
slorber Apr 27, 2021
c91d369
use frontMatter.title in priority for page meta title
slorber Apr 27, 2021
c6cf773
parseMarkdownString should ignore fixed anchor ids syntax
slorber Apr 27, 2021
55cc622
docs: make the distinction between headingTitle + metaTitle more clea…
slorber Apr 27, 2021
ada6369
docs: make the distinction between headingTitle + metaTitle more clea…
slorber Apr 27, 2021
45746c4
writeHeadingIds should ignore top-level md title like "# Title"
slorber Apr 27, 2021
db101be
update tests
slorber Apr 27, 2021
5354b3a
fix doc tests
slorber Apr 27, 2021
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
6 changes: 3 additions & 3 deletions packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Object {
\\"unversionedId\\": \\"foo/bar\\",
\\"id\\": \\"foo/bar\\",
\\"isDocsHomePage\\": false,
\\"title\\": \\"Bar\\",
\\"title\\": \\"Remarkable\\",
\\"description\\": \\"This is custom description\\",
\\"source\\": \\"@site/docs/foo/bar.md\\",
\\"sourceDirName\\": \\"foo\\",
Expand Down Expand Up @@ -182,7 +182,7 @@ Object {
},
\\"sidebar\\": \\"docs\\",
\\"previous\\": {
\\"title\\": \\"Bar\\",
\\"title\\": \\"Remarkable\\",
\\"permalink\\": \\"/docs/foo/bar\\"
},
\\"next\\": {
Expand Down Expand Up @@ -396,7 +396,7 @@ Object {
\\"items\\": [
{
\\"type\\": \\"link\\",
\\"label\\": \\"Bar\\",
\\"label\\": \\"Remarkable\\",
\\"href\\": \\"/docs/foo/bar\\"
},
{
Expand Down
4 changes: 2 additions & 2 deletions packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ describe('simple site', () => {
isDocsHomePage: false,
permalink: '/docs/foo/bar',
slug: '/foo/bar',
title: 'Bar',
title: 'Remarkable',
description: 'This is custom description',
frontMatter: {
description: 'This is custom description',
Expand Down Expand Up @@ -255,7 +255,7 @@ describe('simple site', () => {
isDocsHomePage: true,
permalink: '/docs/',
slug: '/',
title: 'Bar',
title: 'Remarkable',
description: 'This is custom description',
frontMatter: {
description: 'This is custom description',
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ describe('simple website', () => {
'foo',
'bar.md',
),
title: 'Bar',
title: 'Remarkable',
description: 'This is custom description',
frontMatter: {
description: 'This is custom description',
Expand Down
13 changes: 7 additions & 6 deletions 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 @@ -121,9 +121,7 @@ export function processDocMetadata({
frontMatter: unsafeFrontMatter,
contentTitle,
excerpt,
} = parseMarkdownString(content, {
source,
});
} = parseMarkdownString(content);
const frontMatter = validateDocFrontMatter(unsafeFrontMatter);

const {
Expand Down Expand Up @@ -205,8 +203,11 @@ export function processDocMetadata({
numberPrefixParser: options.numberPrefixParser,
});

// Default title is the id.
const title: string = frontMatter.title ?? contentTitle ?? baseID;
// TODO expose both headingTitle+metaTitle to theme?
// Different fallbacks order on purpose!
// See https://github.com/facebook/docusaurus/issues/4665#issuecomment-825831367
const headingTitle: string = contentTitle ?? frontMatter.title ?? baseID;
// const metaTitle: string = frontMatter.title ?? contentTitle ?? baseID;

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

Expand Down Expand Up @@ -245,7 +246,7 @@ export function processDocMetadata({
unversionedId,
id,
isDocsHomePage,
title,
title: headingTitle,
description,
source: aliasedSitePath(filePath, siteDir),
sourceDirName,
Expand Down
20 changes: 11 additions & 9 deletions packages/docusaurus-theme-classic/src/theme/DocItem/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,13 @@ import {

function DocItem(props: Props): JSX.Element {
const {content: DocContent} = props;
const {metadata, frontMatter} = DocContent;
const {
metadata,
frontMatter: {
image,
keywords,
hide_title: hideTitle,
hide_table_of_contents: hideTableOfContents,
},
} = DocContent;
image,
keywords,
hide_title: hideTitle,
hide_table_of_contents: hideTableOfContents,
} = frontMatter;
const {
description,
title,
Expand All @@ -51,9 +49,13 @@ function DocItem(props: Props): JSX.Element {
// See https://github.com/facebook/docusaurus/issues/3362
const showVersionBadge = versions.length > 1;

// For meta title, using frontMatter.title in priority over a potential # title found in markdown
// See https://github.com/facebook/docusaurus/issues/4665#issuecomment-825831367
const metaTitle = frontMatter.title || title;

return (
<>
<Seo {...{title, description, keywords, image}} />
<Seo {...{title: metaTitle, description, keywords, image}} />

<div className="row">
<div
Expand Down
Loading