https://github.com/youssef1313/markdown-links-verifier

A GitHub Action to validate links in Markdown files
https://github.com/youssef1313/markdown-links-verifier

ci github github-action github-actions link-validator markdown

Last synced: 3 months ago
JSON representation

A GitHub Action to validate links in Markdown files

• Host: GitHub
• URL: https://github.com/youssef1313/markdown-links-verifier
• Owner: Youssef1313
• License: mit
• Created: 2021-03-10T13:12:03.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-07T18:57:53.000Z (over 3 years ago)
• Last Synced: 2024-09-14T21:38:47.967Z (4 months ago)
• Topics: ci, github, github-action, github-actions, link-validator, markdown
• Language: C#
• Homepage:
• Size: 85.9 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](CHANGES.md).

## Get started

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

```yml

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/[email protected]

```

## Thanks

- Big thanks to [@jmarolf](https://github.com/jmarolf) for [dotnet-start](https://github.com/jmarolf/dotnet-start) which helped a lot!

- Big thanks to [@IEvangelist](https://github.com/IEvangelist) for [versionsweeper](https://github.com/dotnet/versionsweeper/) which helped a lot!