Skip to content

Commit

Permalink
Add Markdown file linter (#6895)
Browse files Browse the repository at this point in the history
This adds a config file `.markdownlintrc` for use with `markdownlint`.
  • Loading branch information
mhucka authored Jan 14, 2025
1 parent f596c43 commit 326a287
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .markdownlintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Summary: markdownlint-cli config file for Cirq
#
# Note: there are multiple programs programs named "markdownlint". For Cirq,
# we use https://github.com/igorshubovych/markdownlint-cli/, which is the one
# you get with "brew install markdownlint" on MacOS.

# For a list of configuration options, see the following page:
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
# (Beware that the above looks similar but is NOT the same as the page
# https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md.)

# Make exception to the line-length limit of 80 chars in code blocks & tables.
[line-length]
code_blocks = false
tables = false

# Raw HTML is allowed in Markdown, and supported by GitHub.
no-inline-html = false

# Bare URLs are allowed in GitHub-flavored Markdown.
no-bare-urls = false

0 comments on commit 326a287

Please sign in to comment.