-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This adds a config file `.markdownlintrc` for use with `markdownlint`.
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |