terminal/.github/linters/.markdown-lint.yml

---
###########################
###########################
## Markdown Linter rules ##
###########################
###########################

# Linter rules doc:
# - https://github.com/DavidAnson/markdownlint
#
# Note:
# To comment out a single error:
#   <!-- markdownlint-disable -->
#   any violations you want
#   <!-- markdownlint-restore -->
#
# To run the linter locally:
# 1. install the npm package:
#    `npm install -g markdownlint-cli`
# 2. Then run it in the root of the repo with
#    `markdownlint -c .github\linters\.markdown-lint.yml ./*.md`

###############
# Rules by id #
###############
MD004: false                  # Unordered list style
MD007:
  indent: 2                   # Unordered list indentation
MD013:
  line_length: 400            # Line length 80 is far to short
MD024: false                  # Allow multiple headings with same content
MD026:
  punctuation: ".,;:!。，；:"  # List of not allowed
MD029: false                  # Ordered list item prefix
MD033: false                  # Allow inline HTML
MD036: false                  # Emphasis used instead of a heading
MD040: false                  # Allow ``` blocks in md files with no language specified

#################
# Rules by tags #
#################
blank_lines: false  # Error on blank lines
doc: Remove unnecessary link to VC redist, update md lint rules (#7926) Terminal ships with this dependency embedded, and it is not required that you install it separately. Since the link is broken, let's just remove it entirely. * [x] fixes #7889 * [x] related to https://github.com/microsoft/terminal/issues/7917#issuecomment-707955335 * [x] I work here * [x] is a docs update Additionally, update the markdown linter rules in the wake of #7637, because apparently that was never actually applied to any files, so now the onus is on the first person to touch any of our markdown files. 2020-10-15 20:49:11 +02:00			`---`
			`###########################`
			`###########################`
			`## Markdown Linter rules ##`
			`###########################`
			`###########################`

			`# Linter rules doc:`
			`# - https://github.com/DavidAnson/markdownlint`
			`#`
			`# Note:`
			`# To comment out a single error:`
			`# <!-- markdownlint-disable -->`
			`# any violations you want`
			`# <!-- markdownlint-restore -->`
			`#`
			`# To run the linter locally:`
			`# 1. install the npm package:`
			# `npm install -g markdownlint-cli`
			`# 2. Then run it in the root of the repo with`
			# `markdownlint -c .github\linters\.markdown-lint.yml ./*.md`

			`###############`
			`# Rules by id #`
			`###############`
			`MD004: false # Unordered list style`
			`MD007:`
			`indent: 2 # Unordered list indentation`
			`MD013:`
			`line_length: 400 # Line length 80 is far to short`
Add support for autodetecting URLs and making hyperlinks (#7691) This pull request is the initial implementation of hyperlink auto detection Overall design: - Upon startup, TerminalCore gives the TextBuffer some patterns it should know about - Whenever something in the viewport changes (i.e. text output/scrolling), TerminalControl tells TerminalCore (through a throttled function for performance) to retrieve the visible pattern locations from the TextBuffer - When the renderer encounters a region that is associated with a pattern, it paints that region differently References #5001 Closes #574 2020-10-28 21:24:43 +01:00			`MD024: false # Allow multiple headings with same content`
doc: Remove unnecessary link to VC redist, update md lint rules (#7926) Terminal ships with this dependency embedded, and it is not required that you install it separately. Since the link is broken, let's just remove it entirely. * [x] fixes #7889 * [x] related to https://github.com/microsoft/terminal/issues/7917#issuecomment-707955335 * [x] I work here * [x] is a docs update Additionally, update the markdown linter rules in the wake of #7637, because apparently that was never actually applied to any files, so now the onus is on the first person to touch any of our markdown files. 2020-10-15 20:49:11 +02:00			`MD026:`
			`punctuation: ".,;:!。，；:" # List of not allowed`
			`MD029: false # Ordered list item prefix`
			`MD033: false # Allow inline HTML`
			`MD036: false # Emphasis used instead of a heading`
Add support for autodetecting URLs and making hyperlinks (#7691) This pull request is the initial implementation of hyperlink auto detection Overall design: - Upon startup, TerminalCore gives the TextBuffer some patterns it should know about - Whenever something in the viewport changes (i.e. text output/scrolling), TerminalControl tells TerminalCore (through a throttled function for performance) to retrieve the visible pattern locations from the TextBuffer - When the renderer encounters a region that is associated with a pattern, it paints that region differently References #5001 Closes #574 2020-10-28 21:24:43 +01:00			MD040: false # Allow ``` blocks in md files with no language specified
doc: Remove unnecessary link to VC redist, update md lint rules (#7926) Terminal ships with this dependency embedded, and it is not required that you install it separately. Since the link is broken, let's just remove it entirely. * [x] fixes #7889 * [x] related to https://github.com/microsoft/terminal/issues/7917#issuecomment-707955335 * [x] I work here * [x] is a docs update Additionally, update the markdown linter rules in the wake of #7637, because apparently that was never actually applied to any files, so now the onus is on the first person to touch any of our markdown files. 2020-10-15 20:49:11 +02:00
			`#################`
			`# Rules by tags #`
			`#################`
			`blank_lines: false # Error on blank lines`