diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md index 672ae0f503..3ef2d93fad 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md @@ -4,6 +4,8 @@ title: baz slug: bazSlug.html --- +# Baz markdown title + ## Images Like links, Images also have a footnote style syntax diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap index abb22c0f68..9572c7a04d 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap @@ -190,7 +190,7 @@ Object { \\"unversionedId\\": \\"foo/baz\\", \\"id\\": \\"foo/baz\\", \\"isDocsHomePage\\": false, - \\"title\\": \\"baz\\", + \\"title\\": \\"Baz markdown title\\", \\"description\\": \\"Images\\", \\"source\\": \\"@site/docs/foo/baz.md\\", \\"sourceDirName\\": \\"foo\\", @@ -204,7 +204,7 @@ Object { }, \\"sidebar\\": \\"docs\\", \\"previous\\": { - \\"title\\": \\"Remarkable\\", + \\"title\\": \\"Bar\\", \\"permalink\\": \\"/docs/foo/bar\\" }, \\"next\\": { @@ -423,7 +423,7 @@ Object { }, { \\"type\\": \\"link\\", - \\"label\\": \\"baz\\", + \\"label\\": \\"Baz markdown title\\", \\"href\\": \\"/docs/foo/bazSlug.html\\" } ] diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts index 72a8696b4b..9d123cc6cc 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts @@ -286,7 +286,7 @@ describe('simple site', () => { isDocsHomePage: false, permalink: '/docs/foo/bazSlug.html', slug: '/foo/bazSlug.html', - title: 'baz', + title: 'Baz markdown title', editUrl: 'https://github.com/facebook/docusaurus/edit/master/website/docs/foo/baz.md', description: 'Images', @@ -345,7 +345,7 @@ describe('simple site', () => { isDocsHomePage: false, permalink: '/docs/foo/bazSlug.html', slug: '/foo/bazSlug.html', - title: 'baz', + title: 'Baz markdown title', editUrl: hardcodedEditUrl, description: 'Images', frontMatter: { diff --git a/packages/docusaurus-plugin-content-docs/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts index 76eb8af6d8..319549a36a 100644 --- a/packages/docusaurus-plugin-content-docs/src/index.ts +++ b/packages/docusaurus-plugin-content-docs/src/index.ts @@ -199,7 +199,11 @@ export default function pluginContentDocs( nextId, } = sidebarsUtils.getDocNavigation(doc.id); const toDocNavLink = (navDocId: string): DocNavLink => ({ - title: docsBaseById[navDocId].title, + // Use frontMatter.title in priority over a potential # title found in markdown + // See https://github.com/facebook/docusaurus/issues/4665#issuecomment-825831367 + title: + docsBaseById[navDocId].frontMatter.title || + docsBaseById[navDocId].title, permalink: docsBaseById[navDocId].permalink, }); return {