Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • D design
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 21
    • Issues 21
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 16
    • Merge requests 16
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Primer
  • design
  • Merge requests
  • !345

Introduce markdownlinting

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Kate Higa requested to merge kh-markdown-lint into main Dec 21, 2022
  • Overview 9
  • Commits 16
  • Pipelines 0
  • Changes 16

Related: https://github.com/github/accessibility/issues/2542

This PR enables markdown linting pulling in configs from markdownlint-github.

Why? This repo is primarily composed of markdown files. There are valuable markdownlint rules that encourage best accessibility practices. We have config recs centralized in markdownlint-github now that should be pulled in.

markdownlint-github configs enables the markdownlint defaults, but then adds some GitHub custom rules and overrides. Some of markdownlint's defaults are related to stylistic things like line-length and blanks-around-headings. I don't know how much value Primer gets in enforcing these stylistic things so I decided to turn them off. There's also a lot to resolve, but if you think they should be enabled, it should probably be done in a follow-up.

I made sure the rules pertaining to accessibility are kept on since these provide a lot of value and encourage accessibility practices. I think those should be addressed as part of this PR. Open to reviewer opinions!

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: kh-markdown-lint