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
70 changes: 70 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,76 @@ Lorem Ipsum
});
});

it('parses markdown h1 title ending with # when not preceded by space (e.g. C#)', () => {
const markdown = dedent`

# Learn C#

Lorem Ipsum

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

it('parses markdown h1 title ending with # and trailing ATX closing marker', () => {
const markdown = dedent`

# Learn C# #

Lorem Ipsum

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

it('parses markdown h1 title ending with # and custom anchor-id', () => {
const markdown = dedent`

# Learn C# {#learn-c-sharp}

Lorem Ipsum

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

it('parses markdown h1 title ending with attached # (e.g. foo#)', () => {
const markdown = dedent`

# foo#

Lorem Ipsum

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

it('parses empty markdown h1 title with closing # marker only', () => {
const markdown = dedent`

# #

Lorem Ipsum

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

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

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