mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
ebd4a33866
This adds information on how the docs use linting, and more detailed instructions on how to enable it in an IDE, using VSCode as a concrete and widespread example. Additionally, to do this, we add a duplicate style config for markdownlint in JSON format for the Node.js implementation of markdownlint that is used by various editor plugins. These both implement the same core set of warnings, and appear to function identically.
22 lines
536 B
Ruby
22 lines
536 B
Ruby
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
|
|
#
|
|
# When updating rules in this file, ensure the corresponding rule list in
|
|
# .markdownlint.json is also updated.
|
|
|
|
# style
|
|
rule 'header-style'
|
|
rule 'hr-style'
|
|
|
|
# whitespace rules
|
|
rule 'no-missing-space-atx'
|
|
rule 'no-multiple-space-atx'
|
|
rule 'no-missing-space-closed-atx'
|
|
rule 'no-multiple-space-closed-atx'
|
|
rule 'no-space-in-emphasis'
|
|
rule 'no-space-in-code'
|
|
rule 'no-space-in-links'
|
|
|
|
# miscellaneous
|
|
rule 'ol-prefix', :style => :ordered
|
|
rule 'no-reversed-links'
|