From 8da2c12c389d188f3ef232fafbe77fa588300b64 Mon Sep 17 00:00:00 2001 From: Natalie Weizenbaum Date: Mon, 17 Jun 2024 17:51:03 -0700 Subject: [PATCH] Be more explicit about mandated Markdown styles --- .markdownlint-cli2.yaml | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index a456cf8b..53429d31 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -1,6 +1,17 @@ globs: ["**.md"] ignores: ["node_modules/**"] config: + code-block-style: {style: fenced} + code-fence-style: {style: backtick} + emphasis-style: {style: asterisk} + heading-style: {style: atx} + hr-style: {style: "---"} + link-image-style: {collapsed: false} + reference-links-images: {shortcut_syntax: true} + strong-style: {style: asterisk} + table-pipe-style: {style: leading_and_trailing} + ul-style: {style: asterisk} + # BNF syntax examples can go over length, and there's no way to exempt them # specifically. line-length: false @@ -11,9 +22,6 @@ config: # We use untagged code blocks for function definitions. fenced-code-language: false - emphasis-style: - style: asterisk - # We often have to have duplicate subheadings for different parents. no-duplicate-heading: false @@ -24,8 +32,4 @@ config: # We use spaces in code formatting because spaces are relevant in Sass. no-space-in-code: false - reference-links-images: - shortcut_syntax: true - first-line-heading: false - link-image-style: {collapsed: false}