Youssef1313 / markdown-links-verifier

A GitHub Action to validate links in Markdown files
MIT License
4 stars 1 forks source link
ci github github-action github-actions link-validator markdown

Markdown Links Verifier

Markdown Links Verifier is an GitHub Action that helps keeping links in Markdown files in a good state.

For version history, see CHANGES.md.

Get started

To get started, create a markdown-links-verifier.yml under .github/workflows/ directory with the following contents:

name: Markdown links verifier
on: [push, pull_request]

jobs:
  validate_links:
    name: Markdown links verifier
    runs-on: ubuntu-latest

    steps:
    - name: Checkout the repository
      uses: actions/checkout@v1

    - name: Validate links
      uses: Youssef1313/markdown-links-verifier@v0.1.3

Thanks