data/reusables/contributing/content-linter-rules.md

Rule ID	Rule Name(s)	Description	Severity	Tags
MD001	heading-increment	Heading levels should only increment by one level at a time	error	headings
MD011	no-reversed-links	Reversed link syntax	error	links
MD014	commands-show-output	Dollar signs used before commands without showing output	error	code
MD018	no-missing-space-atx	No space after hash on atx style heading	error	headings, atx, spaces
MD019	no-multiple-space-atx	Multiple spaces after hash on atx style heading	error	headings, atx, spaces
MD023	heading-start-left	Headings must start at the beginning of the line	error	headings, spaces
MD027	no-multiple-space-blockquote	Multiple spaces after blockquote symbol	error	blockquote, whitespace, indentation
MD029	ol-prefix	Ordered list item prefix	error	ol
MD030	list-marker-space	Spaces after list markers	error	ol, ul, whitespace
MD031	blanks-around-fences	Fenced code blocks should be surrounded by blank lines	error	code, blank_lines
MD037	no-space-in-emphasis	Spaces inside emphasis markers	error	whitespace, emphasis
MD039	no-space-in-links	Spaces inside link text	error	whitespace, links
MD040	fenced-code-language	Fenced code blocks should have a language specified	error	code, language
MD042	no-empty-links	No empty links	error	links
MD050	strong-style	Strong style	error	emphasis
GH001	no-default-alt-text	Images should have meaningful alternative text (alt text)	error	accessibility, images
GH002	no-generic-link-text	Avoid using generic link text like Learn more or Click here	error	accessibility, links
GHD001	link-punctuation	Internal link titles must not contain punctuation	error	links, url
GHD002	internal-links-no-lang	Internal links must not have a hardcoded language code	error	links, url
GHD003	internal-links-slash	Internal links must start with a /	error	links, url
GHD004	image-file-kebab-case	Image file names must use kebab-case	error	images
GHD005	hardcoded-data-variable	Strings that contain "personal access token" should use the product variable instead	error	single-source
GHD006	internal-links-old-version	Internal links must not have a hardcoded version using old versioning syntax	error	links, url, versioning
GHD007	code-annotations	Code annotations defined in Markdown must contain a specific layout frontmatter property	error	code, feature, annotate, frontmatter
GHD008	early-access-references	Files that are not early access should not reference early-access or early-access files	error	feature, early-access
GHD009	frontmatter-early-access-references	Files that are not early access should not have frontmatter that references early-access	error	frontmatter, feature, early-access
GHD010	frontmatter-hidden-docs	Articles with frontmatter property hidden can only be located in specific products	error	frontmatter, feature, early-access
GHD011	frontmatter-video-transcripts	Video transcript must be configured correctly	error	frontmatter, feature, video-transcripts
GHD012	frontmatter-schema	Frontmatter must conform to the schema	error	frontmatter, schema
GHD013	github-owned-action-references	GitHub-owned action references should not be hardcoded	error	feature, actions
GHD014	liquid-data-references-defined	Liquid data or indented data references were found in content that have no value or do not exist in the data directory	error	liquid
GHD015	liquid-data-tag-format	Liquid data or indented data references tags must be correctly formatted and have the correct number of arguments and spacing	error	liquid, format
GHD016	liquid-quoted-conditional-arg	Liquid conditional tags should not quote the conditional argument	error	liquid, format
GHD017	frontmatter-liquid-syntax	Frontmatter properties must use valid Liquid	error	liquid, frontmatter
GHD018	liquid-syntax	Markdown content must use valid Liquid	error	liquid
GHD019	liquid-if-tags	Liquid ifversion tags should be used instead of if tags when the argument is a valid version	error	liquid, versioning
GHD020	liquid-ifversion-tags	Liquid ifversion tags should contain valid version names as arguments	error	liquid, versioning
GHD021	yaml-scheduled-jobs	YAML snippets that include scheduled workflows must not run on the hour and must be unique	error	feature, actions
GHD022	liquid-ifversion-versions	Liquid ifversion, elsif, and else tags should be valid and not contain unsupported versions.	error	liquid, versioning
GHD031	image-alt-text-exclude-words	Alternate text for images should not begin with words like "image" or "graphic"	error	accessibility, images
GHD032	image-alt-text-end-punctuation	Alternate text for images should end with punctuation	error	accessibility, images
GHD033	incorrect-alt-text-length	Images alternate text should be between 40-150 characters	error	accessibility, images
GHD035	rai-reusable-usage	RAI articles and reusables can only reference reusable content in the data/reusables/rai directory	error	feature, rai
GHD036	image-no-gif	Image must not be a gif, styleguide reference: contributing/style-guide-and-content-model/style-guide.md#images	error	images
GHD038	expired-content	Expired content must be remediated.	warning	expired
GHD039	expiring-soon	Content that expires soon should be proactively addressed.	warning	expired
GHD040	table-liquid-versioning	Tables must use the correct liquid versioning format	error	tables
GHD041	third-party-action-pinning	Code examples that use third-party actions must always pin to a full length commit SHA	error	feature, actions
GHD042	liquid-tag-whitespace	Liquid tags should start and end with one whitespace. Liquid tag arguments should be separated by only one whitespace.	error	liquid, format
GHD043	link-quotation	Internal link titles must not be surrounded by quotations	error	links, url
GHD045	code-annotation-comment-spacing	Code comments in annotation blocks must have exactly one space after the comment character(s)	error	code, comments, annotate, spacing
GHD046	outdated-release-phase-terminology	Outdated release phase terminology should be replaced with current GitHub terminology	error	terminology, consistency, release-phases
GHD047	table-column-integrity	Tables must have consistent column counts across all rows	error	tables, accessibility, formatting
GHD051	frontmatter-versions-whitespace	Versions frontmatter should not contain unnecessary whitespace	error	frontmatter, versions
GHD054	third-party-actions-reusable	Code examples with third-party actions must include disclaimer reusable	error	actions, reusable, third-party
GHD056	frontmatter-landing-recommended	Only landing pages can have recommended articles, there should be no duplicate recommended articles, and all recommended articles must exist	error	frontmatter, landing, recommended
GHD057	ctas-schema	CTA URLs must conform to the schema	error	ctas, schema, urls
GHD058	journey-tracks-liquid	Journey track properties must use valid Liquid syntax	error	frontmatter, journey-tracks, liquid
GHD059	journey-tracks-guide-path-exists	Journey track guide paths must reference existing content files	error	frontmatter, journey-tracks
GHD060	journey-tracks-unique-ids	Journey track IDs must be unique within a page	error	frontmatter, journey-tracks, unique-ids
GHD061	frontmatter-hero-image	Hero image paths must be absolute, extensionless, and point to valid images in /assets/images/banner-images/	error	frontmatter, images
GHD062	frontmatter-intro-links	introLinks keys must be valid keys defined in data/ui.yml under product_landing	error	frontmatter, single-source
search-replace	deprecated liquid syntax: octicon-	The octicon liquid syntax used is deprecated. Use this format instead octicon "<octicon-name>" aria-label="<Octicon aria label>"	error
search-replace	deprecated liquid syntax: site.data	Catch occurrences of deprecated liquid data syntax.	error
search-replace	developer-domain	Catch occurrences of developer.github.com domain.	error
search-replace	docs-domain	Catch occurrences of docs.github.com domain.	error
search-replace	help-domain	Catch occurrences of help.github.com domain.	error
search-replace	todocs-placeholder	Catch occurrences of TODOCS placeholder.	error