Repository navigation
fix: stop repeating the title in Markdown companion pages - #427
Merged
Merged
Conversation
A page whose body opens with a `#` heading shows that heading as its title in HTML, because the site shifts heading levels by -1. The Markdown companion also prepended the front-matter title, so user guide companions opened with two level-1 headings. The companion now uses the leading heading as its title, as the HTML does.
📚 Preview this PR's docs locallyFetch the just-built site and open it in your browser: # this exact build
great-docs preview --run 40011937328
# or always the latest build for this PR
great-docs preview --pr 427Auth & tips
|
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
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.
This PR stops the Markdown companion of a page from opening with its title twice. User guide pages that start their body with a
#heading matching the front-mattertitle, such as the Great Docs introduction, produced companions with two identical level-1 headings at the top (seeintroduction.md).The site's
shift-heading-level-by: -1makes such a leading heading the page title in HTML, so the HTML shows it once. The companion filter reads the page before that shift and added the front-matter title on top of the heading. It now treats a leading#heading as the title, as the HTML does.