Skip to content

doc: fence code blocks #4726

Closed
Closed
@silverwind

Description

@silverwind

Currently, we use 4-space indent to mark code blocks in the docs. It'd be better if we could replace them with backtick fences like js` or c++`. This has two benefits:

  1. It's required for syntax highlighting to work on GitHub
  2. It allows the code samples to be linted with tools like eslint-plugin-markdown

Because this would be another "churn" commit, I'd like to ask for opinions first.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions