Skip to content

chore: Check link fragments in markdownlint

FeRD (Frank Dana) requested to merge ferdnyc/gitlab-vscode-extension:readme-links into main

Description

This MR first enables link-fragments scanning in the Markdownlint configuration. Such scans can flag broken internal document links, which are often the result of changes that modify or remove headings without realizing they were link targets. (The current README contains several such links.)

A second commit then addresses all link-fragment issues raised by markdownlint, so that the CI becomes green again even with link-fragment checking enabled.

Related Issues

Resolves #1196 (closed)

How has this been tested?

$ npx markdownlint-cli -c .markdownlint.yml README.md
README.md:1:3 MD045/no-alt-text Images should have alternate text (alt text)
README.md:20:3 MD051/link-fragments Link fragments should be valid [Context: "[**Auto-complete GitLab CI/CD variables**](#ci-variable-autocompletion)"]
README.md:22:10 MD051/link-fragments Link fragments should be valid [Context: "[multiple GitLab instances](#multiple-gitlab-instances)"]
README.md:120:86 MD051/link-fragments Link fragments should be valid [Context: "[Read more](#git-extension-integration)"]
README.md:147:69 MD051/link-fragments Link fragments should be valid [Context: "[in a previous step](#step-1-create-your-personal-access-token)"]
README.md:342:69 MD051/link-fragments Link fragments should be valid [Context: "[added an access-token](#step-2-add-token-to-gitlab-workflow-extension)"]

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation
  • Chore (Related to CI or Packaging to platforms)
  • Test gap
Edited by FeRD (Frank Dana)

Merge request reports