Skip to content

Conversation

@2coffee2crab
Copy link
Contributor

@2coffee2crab 2coffee2crab commented Aug 19, 2025

Closes #261

Some thoughts on the issue:
Several Markdown implementations allow for an optional feature called front matter, which allows the user to add metadata in YAML format at the start of a Markdown file, surrounded by three dashes.

markdown-oxide does support a small subset of it through its alias feature, which allows a user to add alternative names to the current file. The issue occurs when a comment is present in the front matter section. YAML comments are captured as headings, which is not desired.

Overview of the changes in this PR:

  • src/vault/metadata.rs was extended to allow the MDMetadata struct to hold comments.
  • Tests were added to ensure that regular comments (on a newline) and inline comments were correctly captured.
  • The method MDFile::new() on src/vault/mod.rs was modified: the metadata is captured before the headings, which are filtered to ignore headings that are actually metadata.

Edit: accidentally included an unwanted commit, will fix.
Edit: fixed.

@2coffee2crab 2coffee2crab force-pushed the metadata-with-comments branch from 08e7c93 to 0c8ceff Compare August 19, 2025 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] Comments In YAML Frontmatter Show Up As Headings

1 participant