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 support #3718

Open
AugustinMauroy opened this issue Aug 26, 2024 · 7 comments
Open

📎 markdown support #3718

AugustinMauroy opened this issue Aug 26, 2024 · 7 comments

Comments

@AugustinMauroy
Copy link

AugustinMauroy commented Aug 26, 2024

Description

We need a specification/roadmap to enable contributors to come and contribute correctly.

  • Parser :

For the parser I don't think we need to reinvent the wheel, we can use wooorm/markdown-rs

  • Formating :

We should follow common mark spec to format correctly

@ematipico
Copy link
Member

ematipico commented Aug 28, 2024

@AugustinMauroy what's this task for? I don't really understand. Can you please put more description or context into the issue?

Unless you really want to work on integrating markdown in Biome, we don't usually create tasks unless someone is already interested or working on it.

@AugustinMauroy
Copy link
Author

Unless you really want to work on integrating markdown in Biome, we don't usually create tasks unless someone is already interested or working on it.

I'd like to try, but I'm no expert on rust, so that's why I'm asking for the spec/roadmap of markdown support.

@ematipico
Copy link
Member

ematipico commented Aug 28, 2024

We have a contribution guide that should give you the necessary information to start adding a parser inside Biome: https://github.com/biomejs/biome/blob/main/crates/biome_parser/CONTRIBUTING.md

Regarding the parsing, I believe we could use that crate, however we still need to map their AST to our CST because we need to own the grammar, and the internal APIs.

We've never done this before because all our parsers are built from scratch, so it's something you should explore alone.

itsMapleLeaf added a commit to itsMapleLeaf/remix-electron that referenced this issue Aug 30, 2024
itsMapleLeaf added a commit to itsMapleLeaf/remix-electron that referenced this issue Aug 30, 2024
@suxin2017
Copy link
Contributor

Recently I was digging into biome's architecture and thought I could support this

@dyc3
Copy link
Contributor

dyc3 commented Sep 4, 2024

I think that in order to support markdown effectively, we will need to have #3334 for formatting code blocks, but I don't think that's necessarily a hard blocker. We could start with a naive parser and formatter that doesn't format code blocks. PRs are welcome, but I expect markdown support will have the same priority as yaml support.

@AugustinMauroy
Copy link
Author

hello ! i'm not an expert in rust etc ... But what's the next step for markdown support ?

@dyc3
Copy link
Contributor

dyc3 commented Nov 4, 2024

The lexer and parser is still incomplete. You could take a look in biome_markdown_parser and see what needs doing.

@AugustinMauroy AugustinMauroy changed the title 📎 Markdown spec for markdown support 📎 markdown support Dec 29, 2024
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

No branches or pull requests

4 participants