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

Update Markdown-related meta-docs with info about how to use Markdown linters #7891

Closed
teoli2003 opened this issue Aug 13, 2021 · 1 comment
Labels
markdown Issues related to Markdown conversion

Comments

@teoli2003
Copy link
Contributor

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:

  1. Have a list of common tools
  2. Have a list of correct Markdown structures we want to avoid.
  3. 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.

@teoli2003 teoli2003 added the markdown Issues related to Markdown conversion label Aug 13, 2021
@Rumyra Rumyra added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Nov 25, 2021
@sideshowbarker sideshowbarker removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Jun 22, 2022
@teoli2003
Copy link
Contributor Author

Mardownlint is now run automatically with Husky, and as a test in PRs. The configuration file is also stored in GitHub. This issue is no more useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
markdown Issues related to Markdown conversion
Projects
None yet
Development

No branches or pull requests

3 participants