You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With more and more docs translated into Markdown (#7853), writers are starting to use Markdown tools and especially linters.
For example, I've installed markdownlint in my editor so that I'm aware of errors and write better-formatted docs.
I noticed that the default configuration is asking me to change mark-up we like to mark-up we don't like. E.g., it prefers plain pre blocks with that format:
Pre block content
when we prefer:
```
Pre block content
```
We should list these things, and maybe give info about how to configure (very) common markdown linter.
To solve this, we should:
Have a list of common tools
Have a list of correct Markdown structures we want to avoid.
Update the meta-docs themselves.
Note that if we want to enforce 2. in the future, we will still need this info :-)
Feel free to add info about 1. and 2. here so we can start collecting this info.
The text was updated successfully, but these errors were encountered:
With more and more docs translated into Markdown (#7853), writers are starting to use Markdown tools and especially linters.
For example, I've installed markdownlint in my editor so that I'm aware of errors and write better-formatted docs.
I noticed that the default configuration is asking me to change mark-up we like to mark-up we don't like. E.g., it prefers plain pre blocks with that format:
when we prefer:
We should list these things, and maybe give info about how to configure (very) common markdown linter.
To solve this, we should:
Note that if we want to enforce 2. in the future, we will still need this info :-)
Feel free to add info about 1. and 2. here so we can start collecting this info.
The text was updated successfully, but these errors were encountered: