1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Frontmatter check rules (#42909)

Co-authored-by: Grace Park <gracepark@github.com>
This commit is contained in:
Rachael Sewell
2023-10-05 11:01:09 -07:00
committed by GitHub
parent 55a2249afc
commit 3dd09dd309
21 changed files with 441 additions and 107 deletions

View File

@@ -79,6 +79,26 @@ const githubDocsConfig = {
},
}
export const githubDocsFrontmatterConfig = {
'frontmatter-hidden-docs': {
// GHD034
severity: 'error',
'partial-markdown-files': false,
},
'frontmatter-video-transcripts': {
// GH036
severity: 'error',
'partial-markdown-files': false,
},
'frontmatter-early-access-references': {
// GH060
severity: 'error',
'partial-markdown-files': false,
},
}
// Configures rules from the `github/markdownlint-github` repo
// created by the accessibility team.
const githubMarkdownlintConfig = {
'no-default-alt-text': {
severity: 'error',
@@ -90,6 +110,9 @@ const githubMarkdownlintConfig = {
},
}
// Configures rules from the open-source Markdownlint extension
// search-replace:
// https://www.npmjs.com/package/markdownlint-rule-search-replace
export const searchReplaceConfig = {
'search-replace': {
rules: [
@@ -167,4 +190,5 @@ export const customConfig = {
...searchReplaceConfig,
...githubDocsConfig,
...githubMarkdownlintConfig,
...githubDocsFrontmatterConfig,
}