Skip to content

Commit

Permalink
Disable some formatting linters (#508)
Browse files Browse the repository at this point in the history
Disable linting rules for Markdown syntax that only affect formatting
conventions and do not affect user experience:

- Emphasis marker (`_this syntax_` and `*this syntax*` are both
  acceptable)
- Unordered list marker (can use asterisks and hyphens)
- Ordered list marker (can use all `1.`s or sequential numbers)
  • Loading branch information
ptgott authored Nov 26, 2024
1 parent 0b723cb commit 2d7084d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .remarkrc.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@ import remarkCodeSnippet from "./.build/server/remark-code-snippet.mjs";
import remarkLintDetails from "./.build/server/remark-lint-details.mjs";
import remarkLintFrontmatter from "./.build/server/remark-lint-frontmatter.mjs";
import remarkTOC from "./.build/server/remark-toc.mjs";
import { remarkLintTeleportDocsLinks} from "./.build/server/lint-teleport-docs-links.mjs"
import { remarkLintTeleportDocsLinks } from "./.build/server/lint-teleport-docs-links.mjs";
import {
getVersion,
getVersionRootPath,
} from "./.build/server/docs-helpers.mjs";
import {
loadConfig,
} from "./.build/server/config-docs.mjs";
import { loadConfig } from "./.build/server/config-docs.mjs";

const configFix = {
settings: {
Expand All @@ -35,6 +33,8 @@ const configLint = {
"frontmatter",
"mdx",
"preset-lint-markdown-style-guide",
["lint-emphasis-marker", false],
["lint-unordered-list-marker-style", false],
["lint-table-pipe-alignment", false],
["lint-table-cell-padding", false],
["lint-maximum-line-length", false],
Expand All @@ -46,7 +46,7 @@ const configLint = {
["lint-list-item-spacing", { checkBlanks: true }],
["lint-no-shell-dollars", false],
["lint-list-item-indent", "space"],
["lint-ordered-list-marker-value", "single"],
["lint-ordered-list-marker-value", false],
["lint-maximum-heading-length", false],
["lint-no-shortcut-reference-link", false],
["lint-no-file-name-irregular-characters", false],
Expand Down

0 comments on commit 2d7084d

Please sign in to comment.