roslynator icon indicating copy to clipboard operation
roslynator copied to clipboard

Introduce Markdownlint to project

Open asears opened this issue 4 years ago • 0 comments
trafficstars

This introduces markdown lint which could be added to build after linting issues with API and generated docs ignored or resolved. Might be useful to add to CI builds for project since it relies heavily on generated markdown for documentation.

npm install -g markdownlint-cli
markdownlint **/*.md

From https://github.com/igorshubovych/markdownlint-cli

Current list of warnings from generated markdown, mostly minor.

docs/analyzers/RCS0053.md:13 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* fixes indentation of argumen..."]
docs/analyzers/RCS0053.md:17 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```cs"]
docs/analyzers/RCS0053.md:17 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:21 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
docs/analyzers/RCS0053.md:22 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```cs"]
docs/analyzers/RCS0053.md:22 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:27 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
docs/analyzers/RCS0053.md:28 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```cs"]
docs/analyzers/RCS0053.md:28 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:41 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:51 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:63 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:72 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:84 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:93 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:105 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0053.md:115 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS0054.md:12 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* fixes indentation of multi-l..."]
docs/analyzers/RCS0055.md:12 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* fixes indentation of multi-l..."]
docs/analyzers/RCS1213.md:12 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```editorconfig"]
docs/analyzers/RCS1227.md:22 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS1227.md:35 MD046/code-block-style Code block style [Expected: indented; Actual: fenced]
docs/analyzers/RCS9004.md:40 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* `Microsoft.CodeAnalysis.Chil..."]
docs/analyzers/RCS9006.md:40 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* `Microsoft.CodeAnalysis.Chil..."]
docs/analyzers/RCS9008.md:26 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* `Microsoft.CodeAnalysis.Chil..."]

asears avatar Jan 18 '21 01:01 asears