Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
68 changes: 68 additions & 0 deletions packages/docusaurus-utils/src/__tests__/markdownUtils.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,74 @@ Lorem Ipsum
});
});

it('preserves trailing hash in h1 title when not preceded by whitespace (e.g. C#)', () => {
const markdown = dedent`

# Learn C#

Lorem Ipsum

`;
expect(parseMarkdownContentTitle(markdown)).toEqual({
content: markdown,
contentTitle: 'Learn C#',
});
});

it('preserves trailing hash in h1 title with custom heading id', () => {
const markdown = dedent`

# Learn C# {#learn-csharp}

Lorem Ipsum

`;
expect(parseMarkdownContentTitle(markdown)).toEqual({
content: markdown,
contentTitle: 'Learn C#',
});
});

it('removes atx closing # while preserving trailing hash in heading text', () => {
const markdown = dedent`

# Learn C# #

Lorem Ipsum

`;
expect(parseMarkdownContentTitle(markdown)).toEqual({
content: markdown,
contentTitle: 'Learn C#',
});
});

it('removes atx closing # and custom heading id regardless of ordering', () => {
const markdownWithClosingAfter = dedent`

# Learn C# {#learn-csharp} #

Lorem Ipsum

`;
expect(parseMarkdownContentTitle(markdownWithClosingAfter)).toEqual({
content: markdownWithClosingAfter,
contentTitle: 'Learn C#',
});

const markdownWithClosingBefore = dedent`

# Learn C# # {#learn-csharp}

Lorem Ipsum

`;
expect(parseMarkdownContentTitle(markdownWithClosingBefore)).toEqual({
content: markdownWithClosingBefore,
contentTitle: 'Learn C#',
});
});

it('parses markdown h1 title at the top followed by h2 title', () => {
const markdown = dedent`

Expand Down
4 changes: 3 additions & 1 deletion packages/docusaurus-utils/src/markdownUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,9 @@ export function parseMarkdownContentTitle(
contentTitle: toTextContentTitle(
regularTitleMatch
.groups!.title!.trim()
.replace(/\s*(?:\{#*[\w-]+\}|#+)$/, ''),
.replace(/[ \t]+#+$/, '')
.replace(/\s*\{#*[\w-]+\}$/, '')
.replace(/[ \t]+#+$/, ''),
).trim(),
};
}
Expand Down