Skip to content

fix(content): drop the trailing rule from every rendered section #44

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
miaulalala wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(content): drop the trailing rule from every rendered section #44

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
15 changes: 14 additions & 1 deletion lib/content.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,24 @@ export function splitIntoSections(markdown: string): Section[] {
return seen === 0 ? base : `${base}-${seen + 1}`
}

/*
* Section bodies in the source files end with a `---` separating them from the
* next heading. Once each section is rendered on its own that separator has
* nothing left to separate: it becomes a rule sitting directly above the
* player's own navigation border, so the module ends in two stacked lines.
*
* Stripping it here keeps the raw markdown readable as a document - the rules
* are useful when reading the file - without leaking into the rendered page.
* Only trailing rules go; a rule used mid-section is real content.
*/
const stripTrailingRule = (body: string): string =>
body.replace(/(?:\n[ \t]*(?:-{3,}|\*{3,}|_{3,})[ \t]*)+$/, '').trimEnd()

const push = (heading: string) => {
const { title, id } = parseHeading(heading)
sections.push({
title,
content: currentLines.join('\n').trim(),
content: stripTrailingRule(currentLines.join('\n').trim()),
index: sectionIndex++,
id: uniqueId(id),
})
Expand Down