Add toggle to display YAML/TOML frontmatter #281
Conversation
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
Frontmatter is metadata at the start of markdown files, delimited by `---` (YAML) or `+++` (TOML). It's commonly used by static site generators (Jekyll, Hugo, etc.) for page metadata like title, date, and author. Previously, this extension always stripped frontmatter from the rendered output while extracting the title for the page. This change adds a "frontmatter" toggle in the Content settings that allows users to optionally display the frontmatter block. When displayed, frontmatter is wrapped in a `<div class="frontmatter">` containing a fenced code block (```yaml or ```toml). This approach: - Preserves Prism syntax highlighting for the frontmatter content - Allows targeting `.frontmatter pre code` with CSS for word wrapping, so long lines wrap instead of causing horizontal scroll - Keeps other code blocks unaffected (no wrapping) Title extraction from frontmatter still occurs regardless of whether the frontmatter is displayed.
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.
Frontmatter is metadata at the start of markdown files, delimited by
---(YAML) or+++(TOML). It's commonly used by static site generators (Jekyll, Hugo, etc.) for page metadata like title, date, and author. Previously, this extension always stripped frontmatter from the rendered output while extracting the title for the page.This change adds a "frontmatter" toggle in the Content settings that allows users to optionally display the frontmatter block.
When displayed, frontmatter is wrapped in a
<div class="frontmatter">containing a fenced code block (yaml ortoml). This approach:.frontmatter pre codewith CSS for word wrapping, so long lines wrap instead of causing horizontal scrollTitle extraction from frontmatter still occurs regardless of whether the frontmatter is displayed.
Testing
frontmatter is disabled by default
Enabling frontmatter shows the frontmatter in a formatted code block
Continues to display after menu is exited