{{ message }}
Repository navigation
fix(markdown): keep text before the first heading as a Preface node - #610
Open
jayhemnani9910 wants to merge 1 commit into
Open
jayhemnani9910 wants to merge 1 commit into
jayhemnani9910 wants to merge 1 commit into
Conversation
extract_node_text_content gives each node the text from its heading to the next one, so anything above the first heading belonged to no node and was dropped from the tree. A README's intro, a document whose title is not an ATX heading, and a file with no headings at all (zero nodes) lost that text from the index. Keep it as a Preface node, as both PDF paths already do, at the level of the first heading so the tree shape is unchanged. A leading YAML front matter block is not part of it.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #609
extract_node_text_contentgives each node the text from its heading to the next one, so anything above the first heading belongs to no node and is dropped. That covers a README's intro, a document whose title is a setext heading, and a file with no headings at all, which ends up with zero nodes.This keeps that text as a
Prefacenode, as both PDF paths do (add_preface_if_needed, flash_add_preface). The node takes the level of the first heading so the rest of the tree keeps its shape. A leading YAML front matter block is not included.Tests: four cases in
tests/test_page_index_md.py(preamble, no headings, front matter, file starting with a heading). The first two fail on main.