Skip to content
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.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

markdown frontmatter using yaml (instead of codeblocks) #93

Closed
wants to merge 1 commit into from

Conversation

skwde
Copy link

@skwde skwde commented Feb 15, 2022

This fixes #92 using proposal 1 (see issue).

I simply change the comment string for markdown to ---.

As mentioned in the issue, I could also implement optional support for yaml frontmatter.
Just let me know.

@alpertuna
Copy link
Owner

alpertuna commented Mar 11, 2022

Hi @skwde
I have checked markdown syntax for using three dashes --- as a comment header.

An example;

---
Some header
---

First three dashes are rendered as a seperator and next three dashes make above line a kind of header (title).

I'm not familiar with yaml front matter in markdown so I'm not sure this usage is correct for comment header.

@skwde
Copy link
Author

skwde commented Mar 25, 2022

Hi @alpertuna,

thanks for your quick response and sorry for my late one :).

Anyways, yes this looks fine to me.

I guess it depends on what renders markdown if the header is properly recognized.
In any case, I have never seen a fenced code block (as was used previously) being interpreted as a comment.

@alpertuna alpertuna closed this Aug 10, 2023
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.

Markdown header / frontmatter
2 participants