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

Add lang to code blocks in Markdown #5299

Merged
merged 4 commits into from May 14, 2021
Merged

Add lang to code blocks in Markdown #5299

merged 4 commits into from May 14, 2021

Commits on May 13, 2021

  1. Add lang to code blocks in Markdown

    This change aims to make documents more readable and avoid syntax errors
    by adding a language specifier to code blocks in Markdown.
    
    To perform this task efficiently, I use two remark plugins:
    - [remark-lint-code-block-syntax](https://github.com/ybiquitous/remark-lint-code-block-syntax)
    - [remark-lint-fenced-code-flag](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-fenced-code-flag)
    
    ```diff
    --- a/package.json
    +++ b/package.json
    @@ -66,7 +66,9 @@
       },
       "remarkConfig": {
         "plugins": [
    -      "@stylelint/remark-preset"
    +      "@stylelint/remark-preset",
    +      "remark-lint-code-block-syntax",
    +      "remark-lint-fenced-code-flag"
         ]
       },
       "jest": {
    @@ -189,6 +191,8 @@
         "postcss-import": "^12.0.1",
         "prettier": "^2.2.1",
         "remark-cli": "^9.0.0",
    +    "remark-lint-code-block-syntax": "^0.2.1",
    +    "remark-lint-fenced-code-flag": "^2.0.1",
         "typescript": "^4.2.4"
       },
       "engines": {
    ```
    
    Note: I do not recommend the addition of the plugins because they produce false positives.
    ybiquitous committed May 13, 2021
    Configuration menu
    Copy the full SHA
    5eabc24 View commit details
    Browse the repository at this point in the history

Commits on May 14, 2021

  1. Configuration menu
    Copy the full SHA
    47c23ae View commit details
    Browse the repository at this point in the history
  2. Remove deprecated files

    ybiquitous committed May 14, 2021
    Configuration menu
    Copy the full SHA
    2754578 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    99b16f4 View commit details
    Browse the repository at this point in the history