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

chore: add markdown linter rules for code blocks #2020

Merged
merged 1 commit into from
Nov 13, 2023

Conversation

ajpinedam
Copy link
Contributor

@ajpinedam ajpinedam commented Nov 12, 2023

GitHub Issue (If applicable): closes #

PR Type

What kind of change does this PR introduce?

  • Other... Please describe: Adding linter support for the documentation

What is the current behavior?

What is the new behavior?

Adding support for the Markdown linter and enabling the Code Block to remove the warning with the indentation.

This is the default configuration :

{
    "default": true,
    "MD013": false,
}

adding

    "no-hard-tabs": {"code_blocks": false}

Will disable checking for hard tabs on code blocks.

Before After
mk-linter-before mk-linter-after

Important: Ideally, we should use this for all our Markdown-based documentation, but starting with this repository.

Useful VSCode Extension: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tested code with current supported SDKs
  • Docs have been added/updated which fit documentation template. (for bug fixes / features)
  • Unit Tests and/or UI Tests for the changes have been added (for bug fixes / features) (if applicable)
  • Wasm UI Tests are not showing unexpected any differences. Validate PR Screenshots Compare Test Run results.
  • Contains NO breaking changes
  • Updated the Release Notes
  • Associated with an issue (GitHub or internal)

Other information

Internal Issue (If applicable):

@ajpinedam ajpinedam self-assigned this Nov 12, 2023
@nickrandolph nickrandolph merged commit 3233595 into main Nov 13, 2023
6 of 7 checks passed
@nickrandolph nickrandolph deleted the chore/enable.markdown.linkter branch November 13, 2023 06:20
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

Successfully merging this pull request may close these issues.

None yet

2 participants