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

RFC: change syntax of yfm-notes (move to directive syntax) #44

Open
d3m1d0v opened this issue Jan 24, 2025 · 0 comments
Open

RFC: change syntax of yfm-notes (move to directive syntax) #44

d3m1d0v opened this issue Jan 24, 2025 · 0 comments
Labels
RFC Request for Comments

Comments

@d3m1d0v
Copy link
Member

d3m1d0v commented Jan 24, 2025

Description

The syntax of YFM-Notes is quite complex and inconvenient. There are several issues with it:

  • curly liquid-like syntax for open and close block. It requires its exact spelling, empty lines before and after the content, named closing syntax
  • strange behavior of title and autotitle
    • adds autotitle by default
    • "" – autotitle is disabled
    • "<title>" – adds custom title

Proposal

First, add support of directive syntax for YFM-Notes block: replace curly markup of opening and closing with directive syntax.

Example:
:::info
This is info.
:::

:::tip
This is a tip.
:::

:::warning
This is a warning.
:::

:::alert
alert
:::

Second, disable the auto-title by default and add "autotitle=true" attribute to enable it manually.

@d3m1d0v d3m1d0v added the RFC Request for Comments label Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFC Request for Comments
Projects
None yet
Development

No branches or pull requests

1 participant