Skip to content
This repository was archived by the owner on Dec 14, 2021. It is now read-only.
This repository was archived by the owner on Dec 14, 2021. It is now read-only.

A few warnings/errors from markdownlint #100

@pdehaan

Description

@pdehaan

I'm sure a few of these are somewhat moot with refactorings in WIP pull requests, or not all of these markdown files being used to build the front end, but figured this may be the "best place"(tm) for me to stash my .markdownlint.json config file.

$ cat .markdownlint.json
{
  "header-style": false,
  "line-length": false,
  "no-inline-html": false,
  "ul-indent": false,
  "ul-style": false
}
$ npx markdownlint-cli (rework|privacy|faq).md

faq.md: 19: MD002/first-heading-h1/first-header-h1 First heading should be a top level heading [Expected: h1; Actual: h4]
faq.md: 80: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On Desktop"]
faq.md: 89: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On iOS"]
faq.md: 98: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On Android"]
faq.md: 105: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On iOS"]
faq.md: 127: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On Android"]
privacy.md: 12: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

The duplicate header issue is an interesting one. It looks like Jekyll (or whatever is ultimately processing these) is smartly converting potential duplicate IDs to "is-ios", "is-ios-1", and "is-ios-2" respectively, so isn't exactly a problem. But we do have some odd <a id=""> tags in addition to the automatically generated heading IDs which can cause duplicate IDs to be a potential issue:

<a id="how-do-i-enable-sync-on-firefox">
### How do I enable sync on Firefox?

Which then compiles to:

<p><a id="how-do-i-enable-sync-on-firefox"></a></p>
<h3 id="how-do-i-enable-sync-on-firefox">How do I enable sync on Firefox?</h3>

NOTE: Here was the original list, which showed all root *.md files vs just the ones that get served via the website:

$ npx markdownlint-cli *.md
faq.md: 19: MD002/first-heading-h1/first-header-h1 First heading should be a top level heading [Expected: h1; Actual: h4]
faq.md: 80: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On Desktop"]
faq.md: 89: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On iOS"]
faq.md: 98: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On Android"]
faq.md: 105: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On iOS"]
faq.md: 127: MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "#### On Android"]
index.md: 23: MD045/no-alt-text Images should have alternate text (alt text)
index.md: 26: MD045/no-alt-text Images should have alternate text (alt text)
index.md: 29: MD045/no-alt-text Images should have alternate text (alt text)
privacy.md: 12: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
process.md: 13: MD010/no-hard-tabs Hard tabs [Column: 1]
process.md: 14: MD010/no-hard-tabs Hard tabs [Column: 1]
process.md: 15: MD010/no-hard-tabs Hard tabs [Column: 1]
process.md: 16: MD010/no-hard-tabs Hard tabs [Column: 1]
process.md: 17: MD010/no-hard-tabs Hard tabs [Column: 1]
process.md: 26: MD002/first-heading-h1/first-header-h1 First heading should be a top level heading [Expected: h1; Actual: h2]
process.md: 50: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
process.md: 61: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 4]
process.md: 81: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 4]
process.md: 83: MD010/no-hard-tabs Hard tabs [Column: 1]
process.md: 89: MD010/no-hard-tabs Hard tabs [Column: 1]
process.md: 91: MD010/no-hard-tabs Hard tabs [Column: 1]
process.md: 93: MD010/no-hard-tabs Hard tabs [Column: 1]
process.md: 116: MD005/list-indent Inconsistent indentation for list items at the same level [Expected: 4; Actual: 2]
process.md: 146: MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "Priorities"]
process.md: 152: MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "Issue Types"]
process.md: 162: MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "Closed Issue Resolutions"]
process.md: 170: MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "Open Questions or Help Needed"]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions