gmuv

README

GitHub's Markdown URL Validator

Overview

gmuv stands for GitHub's Markdown URL Validator. gmuv is an open-source CLI tool to check/validate broken/failure links in Markdown files(*.md) for public Github repositories under a certain account.

Quick start

Local installation

Go (requires ver. >= 1.18) and git installed on Linux OS:

go install github.com/groovy-sky/gmuv/v2@latest

Using Docker image

docker run -it golang:latest
go install github.com/groovy-sky/gmuv/v2@latest

Commands

To see available options run following command:

gmuv -h

To check and validate links under a specific account and write output to the console:

gmuv -u groovy-sky -o cli

To check and validate links under a specific account's repository and write output to 'result.md' file:

gmuv -u groovy-sky -r aaa -f result.md

Run gmuv from Github Marketplaces:

      - name: Generate a report
        uses: groovy-sky/gmuv@v1.1.1
        with:
          account: groovy-sky
          repository: aaa
          filename: output.md

ToDo

• Learn how-to and write tests
• Publish a docker image to Github registry
• Improve code quality
• Learn how-to use Codecov

* Choose which one CLI to use (standard, urfave/cli, spf13/cobra)

* Setup workflow for building packages for different platforms (386,amd64 etc.)

License

This project is released under the BSD-3-Clause license.