Markdown Support

[suxin2017]

markdown is also already in prettify and is what you need.

So our markdown support is also important, using this pr to support basic markdown

For now, I'm going to use this ebnf syntax and see if I can match it with prettify later.

https://www.mediawiki.org/wiki/Markup_spec/EBNF

Why not an existing library?

Because converting from an existing ast to biome's cst and ast is tedious and not always possible, just like the css implementation, we can achieve a more fine-grained improvement by doing it ourselves.

This pr only implements the ast part of markdown, we will add support for format/lint when the ast part is stable

#3718

Reference Links

https://www.mediawiki.org/wiki/Markup_spec/EBNF

https://github.github.com/gfm/

https://github.com/syntax-tree/mdast

https://commonmark.org/

Progress tracking

• project struct init feat(markdown): support markdown grammar code generation #3775

  • grammer support
  • support commonmark grammer defined

• grammer implementation

  • block

    • leaf block
    • 4.1Thematic breaks feat(markdown/parser): support thematic break block parser #3982
    • 4.2ATX headings
    • 4.3Setext headings
    • 4.4Indented code blocks
    • 4.5Fenced code blocks
    • 4.6HTML blocks
    • 4.7Link reference definitions
    • 4.8Paragraphs
    • 4.9Blank lines
    • container bloock
    • 5.1Block quotes
    • 5.2List items
    • 5.3Lists

  • inline block

    • 6.1Code spans
    • 6.2Emphasis and strong emphasis
    • 6.3Links
    • 6.4Images
    • 6.5Autolinks
    • 6.6Raw HTML
    • 6.7Hard line breaks
    • 6.8Soft line breaks
    • 6.9Textual content
    • Appendix: A parsing strategy

• extension support

  • gfm support

[Conaclos]

Are we aiming for compliance to the CommonMark spec?

[suxin2017]

The ultimate goal is to finish making commonmark spec at https://github.github.com/gfm/

[AugustinMauroy]

GFM must be a option it's shouldn't be the default option

[AugustinMauroy]

I was wondering if it was possible to support MDX easily. Because biome already supports JSX.

[AugustinMauroy]

Okay good to know. 👍

[AugustinMauroy]

IDK what is the politic of biome on create. Bu there are a mdx parser https://github.com/wooorm/mdxjs-rs so is it possible to use on biome ?

[ematipico]

Technically speaking, the only way to support other parsers inside Biome, is to map the other parser nodes (AST/CST) to Biome CST.

I'm not sure what you mean by "politic". We simply haven't tried this approach and we don't have the bandwidth to explore it, so you're more than welcome to explore this solution and see if it's viable

[AugustinMauroy]

I mean by politic, is the policy about third dep on biome

[dyc3]

We generally try to minimize our dependency tree, but we don't explicitly prohibit bringing in new dependencies. It has to provide enough value for the project as a whole. For example, we won't bring in a dependency to be used for a single lint rule, but we would bring in a dependency for a specific data structure that someone else has already implemented.

All of biome's language parsers are implemented by us currently. If we were to bring in a package for parsing a new language, it would have to fit in to the rest of biome's parsing infrastructure. Like @ematipico said, PRs welcome.

[AugustinMauroy]

And what about "metadata" ?

[dyc3]

Are you talking about frontmatter?

[AugustinMauroy]

Yeah yeah

[dyc3]

IIRC that's a part of the common mark spec so yeah, support for that is planned. Potentially also requires #3334 and maybe even #2365