From 326a287f9a195097d30410fe8228a58f4078bd35 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Tue, 14 Jan 2025 08:51:07 -0800 Subject: [PATCH] Add Markdown file linter (#6895) This adds a config file `.markdownlintrc` for use with `markdownlint`. --- .markdownlintrc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .markdownlintrc diff --git a/.markdownlintrc b/.markdownlintrc new file mode 100644 index 00000000000..db01817b4a9 --- /dev/null +++ b/.markdownlintrc @@ -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