Automated: Runs on PRs and deploy when src/pages/** files change

Manual: npm run lint

Validates markdown syntax, links, content structure, and Adobe style guidelines.

Running the Linter

You can run the linter using npx:

# Run all linting rules (errors and summary only)
npx --yes github:AdobeDocs/adp-devsite-utils runLint

# Run with verbose output (shows all files processed and details)
npx --yes github:AdobeDocs/adp-devsite-utils runLint -v

# Check only for dead external links
npx --yes github:AdobeDocs/adp-devsite-utils runLint --external-links-only

# Check dead links (external + internal)
npx --yes github:AdobeDocs/adp-devsite-utils runLint --external-links-only --internal-links-only

Options:

• -v or --verbose - Show detailed output including all files processed
• --external-links-only - Only check for dead external URLs (skips all other linting rules)
• --internal-links-only - Validate internal links (local file paths) via filesystem check. Use with --external-links-only to check both

Skipping URL patterns:

If you have external URLs that should be excluded from dead link checking, you can configure patterns to skip in your package.json:

{
  "lint": {
    "skipUrlPatterns": [
      "jqueryvalidation.org",
      "adobedocs.github.io"
    ]
  }
}

Skipping Frontmatter Paths

If you have frontmatter paths that should be excluded from linter checking to avoid unnecessary warnings, you can configure paths to skip in your package.json:

{
 "lint": {
    "skipFrontmatterPaths": [
      "src/pages/fragments/"
    ]
 }
}

Troubleshooting

If pages are not showing up as expected, check lint errors or warnings to identify potential issues.