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

Move to comment highlighting in markdown code blocks #180

Open
fussel178 opened this issue Feb 5, 2022 · 0 comments
Open

Move to comment highlighting in markdown code blocks #180

fussel178 opened this issue Feb 5, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@fussel178
Copy link
Member

Docusaurus supports two types of line highlighting in markdown code blocks:

Currently, our documentation uses both types.

I think, it's better to switch to highlighting with comments, because later code changes over multiple lines don't break, as highlighting with metadata would do.

@fussel178 fussel178 added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 5, 2022
@pklaschka pklaschka added this to the v2.9 milestone Mar 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants