Skip to content

考虑遵循 Markdownlint 的代码风格以保证可读性和风格一致性 #1

@k4yt3x

Description

@k4yt3x

Repository 里的文章代码风格不太一致,也没有遵循一些 best practice。例如代码块开始的时候没有标注语言,这样有些静态页面上生成器或者主题将无法正确高亮代码。

比如说这里就应该标注 console

image
Repo 中未标注语言的代码块

以下是 Cisco 的用例

image
Cisco Markdown 代码用例

markdownlint 里制定了一些类似于 Python PEP8 的规则让代码更可读,可以考虑遵循这个插件的提示修改一下代码风格。

image
例一:标题后没有空行

image
例二:代码块没有标注语言

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions