Skip to content

Markdown: handle unicode list markers #257

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

Merged
platypii merged 1 commit into from
Jun 5, 2025
Merged

Markdown: handle unicode list markers #257

Show file tree
Hide file tree
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
16 changes: 16 additions & 0 deletions src/components/Markdown/Markdown.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,22 @@ describe('Markdown lists', () => {
expect(codeBlock).toBeDefined()
expect(codeBlock?.textContent).toContain('console.log("Nested code")')
})

it('renders a list with unicode dash –', () => {
const text = '– Item 1\n– Item 2\n– Item 3\n\n'
const { getByText } = render(<Markdown text={text} />)
expect(getByText('Item 1')).toBeDefined()
expect(getByText('Item 2')).toBeDefined()
expect(getByText('Item 3')).toBeDefined()
})

it('renders a list with unicode dot •', () => {
const text = '• Item 1\n• Item 2\n• Item 3\n\n'
const { getByText } = render(<Markdown text={text} />)
expect(getByText('Item 1')).toBeDefined()
expect(getByText('Item 2')).toBeDefined()
expect(getByText('Item 3')).toBeDefined()
})
})

describe('Markdown with nested elements', () => {
Expand Down
8 changes: 4 additions & 4 deletions src/components/Markdown/Markdown.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ function parseMarkdown(text: string): Token[] {
}

// List (ordered or unordered)
const listMatch = /^(\s*)([-*+]|\d+\.)\s+(.*)/.exec(line)
const listMatch = /^(\s*)([-*+–•‣◦○⚬]|\d+\.)\s+(.*)/.exec(line)
if (listMatch !== null) {
if (!(1 in listMatch) || !(2 in listMatch)) {
throw new Error('Missing entries in regex matches')
Expand Down Expand Up @@ -109,7 +109,7 @@ function parseMarkdown(text: string): Token[] {
if (ln.startsWith('```')) break // code block
if (ln.startsWith('>')) break // blockquote
if (/^(#{1,6})\s+/.test(ln)) break // heading
if (/^(\s*)([-*+]|\d+\.)\s+/.test(ln)) break // list item
if (/^(\s*)([-*+–•‣◦○⚬]|\d+\.)\s+/.test(ln)) break // list item

paraLines.push(ln)
i++
Expand Down Expand Up @@ -137,7 +137,7 @@ function parseList(lines: string[], start: number, baseIndent: number): [Token[]
}

// This matches a new top-level bullet/number for the list
const match = /^(\s*)([-*+]|\d+\.)\s+(.*)/.exec(line)
const match = /^(\s*)([-*+–•‣◦○⚬]|\d+\.)\s+(.*)/.exec(line)
// If we don't find a bullet/number at the same indent, break out
if (match === null || !(1 in match) || match[1].length !== baseIndent || !(3 in match)) {
break
Expand Down Expand Up @@ -186,7 +186,7 @@ function parseList(lines: string[], start: number, baseIndent: number): [Token[]
}

// Check for nested list
const sublistMatch = /^(\s*)([-*+]|\d+\.)\s+(.*)/.exec(subline)
const sublistMatch = /^(\s*)([-*+–•‣◦○⚬]|\d+\.)\s+(.*)/.exec(subline)
if (sublistMatch && 1 in sublistMatch && sublistMatch[1].length > baseIndent && 2 in sublistMatch) {
const newBaseIndent = sublistMatch[1].length
const ordered = /^\d+\./.test(sublistMatch[2])
Expand Down