Skip to content

AaronWharton/mdreminder

Repository files navigation

mdreminder

Build Status Go Report Card codecov DUB Coverage Status

Introduction

Have you ever been bothered by plenty of invalid url links in the porject especially when you change the project structure, which contains several *.md files that contain many links? mdreminder is exactly the project for detecting invalid links in *.md files at one time, which is lightweight and user-friendly.

Usage

First you should go get it:

go get -u github.com/AaronWharton/mdreminder

Then just run it by coding like this:

package main

import "github.com/AaronWharton/mdreminder"

func main() {
    mdreminder.ExecuteByPath("/Users")  // you can choose the path you want to detect, note some directories may need access permission
}

Finally see the result in the ouput, you can see the example here.

Contribute

Project now is under developping, any pull request is welcome! If you have any question you can new issue.

License

mdreminder is open-source software licensed under the MIT License.