Skip to content

Simple dotnet tool to check a folder containing markdown files for broken links. (e.g. an ADO Wiki). Can be used in a pipeline.

License

Notifications You must be signed in to change notification settings

roel4ez/CheckMarkdownLinks

Repository files navigation

.NET Core

Getting started

  1. For example, pull the Demo-Wiki to \Demo-Wiki.
  2. cd src\CheckMarkdownLinks.Console
  3. dotnet build
  4. dotnet run -- -i <path>\Demo-Wiki

output will be similar to:

Run tests

  1. cd tst\CheckMarkdownLinks.Tests
  2. dotnet test

Install as dotnet tool

  • dotnet tool install CheckMarkdownLinks --version 1.0.1-alpha

Open Issues

  • add build.cmd for easy build
  • add demo wiki
  • additional tests
  • Support for additional markdown extension such as *.markdown
  • Decent checking of web URL with correct return code.
  • Checking of document anchor links
  • add verbose flag
  • Github action to build and publish package
  • False positives happen due to case insensitive File.Exists check. Can probable be done with a PInvoke on FindFirstFileEx

About

Simple dotnet tool to check a folder containing markdown files for broken links. (e.g. an ADO Wiki). Can be used in a pipeline.

Resources

License

Stars

Watchers

Forks

Packages

No packages published