Skip to content

Commit

Permalink
Disable the ul-style rule (#17)
Browse files Browse the repository at this point in the history
> While enforcing a certain unordered list style can be somewhat helpful
for making the Markdown source easier to read with a screen reader, this
rule is ultimately too opinionated and noisy to be worth it, especially
because it conflicts with the editor's bulleted list toolbar button.

Closes #16
  • Loading branch information
iansan5653 authored Aug 2, 2023
1 parent 3488b4b commit 2576b5f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions src/utilities/lint-markdown.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ export const lintMarkdown = (markdown: string): LintError[] =>
default: false,
"no-reversed-links": true,
"no-empty-links": true,
// While enforcing a certain unordered list style can be somewhat helpful for making the Markdown source
// easier to read with a screen reader, this rule is ultimately too opinionated and noisy to be worth it,
// especially because it conflicts with the editor's bulleted list toolbar button.
"ul-style": false,
}),
handleRuleFailures: true,
customRules: markdownlintGitHub,
Expand All @@ -39,6 +43,4 @@ export const ruleJustifications: Partial<Record<string, string>> = {
"Using headers to separate sections helps readers use accessibility tools to navigate documents.",
"ol-prefix":
"When reading Markdown source code, out-of-order lists make it more difficult for non-sighted users to understand how long a list is.",
"ul-style":
"While reading Markdown source code, screen readers typically read out asterisks whereas other symbols are ignored or converted to pauses.",
};

0 comments on commit 2576b5f

Please sign in to comment.