Migrating to GHEC

MD005 - Inconsistent indentation for list items at the same level

Items in bullet and numbered list need to have the same number of indent spaces.

MD010 - No hard tabs

Hard tab characters need to be spaces.

MD031 - Code blocks should be surround by blank lines

You need blank lines above and below the code blocks. This rule also applies to code blocks in notes.

MD032 - Lists should be surrounded by blank lines

You need blank lines above and below the lists. This rule also applies to lists in notes.

MD037 - Spaces at the start or end of emphasis syntax are no longer allowed.

Syntax such as **This is bold** won’t pass if there is a space after the start syntax or before the end syntax.

MD038 - Spaces at the start or end of code blocks are no longer allowed.

` VisitorAPI.js` will be flagged.

MD046 - Code block style inconsistency

This rule is tricky to troubleshoot. There are basically two ways to create code blocks: with triple backticks (fenced) or by indenting. The MD046 error mentions that a code block is fenced when it should be indented. What makes it tricky is that the error usually happens much earlier in the file with an improper indent in a list. Look before the line number to make sure that nested items between lists are indented properly and that you don’t indent a line unless it’s in a step. Or ping Bob.

MD055/MD056 - tables

For example, pipe characters in tables need to be preceded by a backslash to display. Tables must have the same number of pipe characters.

AM004 - Malformed table

Spaces are not allowed after the closing pipe character in a table row.

AM009 - Malformed note

Catches issues like >![NOTE] (should be >[!NOTE])

AM015 - Comment syntax (in-progress)

Flags commenting problems such as unmatched open/close syntax, nested syntax, and multiple comments in the same paragraph. In-progress.

AM016 - mismatched symbols not escaped.

Syntax such as '{' will be flagged unless you escape the characters.

AM020 - frontmatter-validation, especially deprecated role values

Old deprecated role values no longer allowed: Architect, Engineer, Data Engineer

AM030/AM031 - Anchors cannot be one of the reserved anchor ids

For example, a {#search} anchor can cause problems for some rendering engines.

AM046 - Missing links not found.

Broken links in unused .md files (files not in TOC) are now flagged as errors. To remove these errors, either rename the file suffix (such as overview.draft or readme.txt) or fix/comment out the links.

This rule also flags bad links such as this (note the redundant brackets):

[requisition lists]([https://experienceleague.adobe.com/docs/commerce-admin/b2b/requisition-lists/requisition-lists.html](https://experienceleague.adobe.com/docs/commerce-admin/b2b/requisition-lists/requisition-lists.html))

and this: [link text](file.md/#deep-link) (need to remove slash for link to work)

AM047 - Invalid filenames

In v1, we intercepted and changed filenames that include underscores and uppercase letters during post-processing. In v2, we no longer post-process files in the same way, so we flag invalid filenames such as sendPushSubscription.md or send_push.md as errors.

AM049 - TOC validation

There are tighter rules for TOC.md files. For example, adding inline comments to TOC entries is now flagged to avoid rendering problems.

AM054 - Commenting requirements. See next section about new rules for comments.

AM062 - Linked repo asset exceeds allowed file size. In this case, SVG cannot be larger than 140 KB due to an EDS limitation.

AM063 - Inline triple backticks are not allowed at this time. This rule is likely temporary because we want to allow a way to use triple inline backticks to wrap a single backtick that needs to be part of an inline code block. For now, don’t use triple backticks inline.