GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → bmuschko → link-verifier

bmuschko / link-verifier

Licence: Apache-2.0 license
A tool for verifying links in text-based files

Programming Languages

go
31211 projects - #10 most used programming language
shell
77523 projects

Labels

markdowncheckerverificationasciidoclink

Projects that are alternatives of or similar to link-verifier

verify-apple-id-token
Verify the Apple id token on the server side.
Stars: ✭ 49 (+88.46%)
Mutual labels:  verification
node-w3c-validator
Wrapper for The Nu Html Checker (v.Nu)
Stars: ✭ 28 (+7.69%)
Mutual labels:  checker
garn-validator
Create validations with ease
Stars: ✭ 42 (+61.54%)
Mutual labels:  checker
remark-bookmarks
plugin to manage links
Stars: ✭ 15 (-42.31%)
Mutual labels:  link
fusionauth-site
Website and documentation for FusionAuth
Stars: ✭ 24 (-7.69%)
Mutual labels:  asciidoc
health-check
Health Check is an application that provides an API to check the health health_check of some parts and some utilities like ping requests. This application can works as standalone or included in a Django project.
Stars: ✭ 31 (+19.23%)
Mutual labels:  checker
core-v-verif
Functional verification project for the CORE-V family of RISC-V cores.
Stars: ✭ 283 (+988.46%)
Mutual labels:  verification
CheckStyle
在协同开发中让代码风格保持一致
Stars: ✭ 25 (-3.85%)
Mutual labels:  checker
svelte-link-preview
Svelte port of @dhaiwat10/react-link-preview
Stars: ✭ 12 (-53.85%)
Mutual labels:  link
yggdrasil
No description or website provided.
Stars: ✭ 26 (+0%)
Mutual labels:  verification
passport-activedirectory
Active Directory strategy for passport.js
Stars: ✭ 28 (+7.69%)
Mutual labels:  verification
affiliate
Add affiliation tags to links automatically in the browser
Stars: ✭ 77 (+196.15%)
Mutual labels:  link
react-use-downloader
Creates a download handler function and gives progress information
Stars: ✭ 65 (+150%)
Mutual labels:  link
DocumentReader-iOS
iOS Framework for reading and validation of identification documents
Stars: ✭ 54 (+107.69%)
Mutual labels:  verification
civet
Continuous Integration, Verification, Enhancement, and Testing
Stars: ✭ 30 (+15.38%)
Mutual labels:  verification
laravel-otp-login
Adds a customizable, translatable, configurable OTP verification step to Laravel Auth. You can add your own SMS provider too.
Stars: ✭ 16 (-38.46%)
Mutual labels:  verification
ngx-translate-lint
Simple CLI tools for check `ngx-translate` keys
Stars: ✭ 25 (-3.85%)
Mutual labels:  checker
klever
Read-only mirror of the Klever Git repository
Stars: ✭ 18 (-30.77%)
Mutual labels:  verification
Discord-Token-Checker
🔥Fastest Parallel Request Double-Check Discord Token Checker🔥 Parse discord tokens from any file and directory.
Stars: ✭ 36 (+38.46%)
Mutual labels:  checker
neural-network-lyapunov
Synthesizing neural-network Lyapunov functions (and controllers) as stability certificate.
Stars: ✭ 82 (+215.38%)
Mutual labels:  verification
View All Similar Projects ➔

Link Verifier Build Status Go Report Card Codecov

A tool for verifying links in text-based files. Written in Go, available as executable.

Logo

Motivation

Ambitious tech writers use plain-text mark-up formats like AsciiDoc and Markdown for turning text into properly formatted blog posts, web pages and documentation. Incorporating URLs to refer to external resources is part of the process. Before publishing content it’s important to verify that linked URLs are valid and can be resolved. Nothing feels more unprofessional than broken links in a carefully crafted document.

Link verifier to the rescue! Automatically discover all mark-up files in a given directory and verify all links found in the documents before publishing them.

Installation

Prebuilt libraries

Prebuilt libraries for various platforms are available on GitHub. Just download, exact the archive and execute the binary.

Building from source

Building from source requires that you have Go installed on your machine.

go get -u -v github.com/bmuschko/link-verifier

Run the program with link-verifier from anywhere in the file system.

Command line options

Table 1. Parameters
Option Description Default Value

dirs

The comma-separated root directories used to recursively search for files.

[.]

includes

The comma-separated include patterns used to search for files.

[*.md,*.adoc]

ignore-status-codes

The comma-separated HTTP response status codes that will be ignored for validation. For example, some sites block crawlers and return with a specific response code.

[]

fail

Fails the program if at least one discovered link cannot be resolved.

true

timeout

The timeout in seconds used when calling the URL.

5

Example:

link-verifier --dirs data,content --include *.html,*.yml --fail=false

Usage on CI

Integrating the tool with a build on CI is a breeze and can used as validation step before publishing mark-up files.

Travis CI

The following .travis.yml demonstrate the use of the prebuilt binary version on Linux 64 bit:

before_script:
  - wget https://github.com/bmuschko/link-verifier/releases/download/v0.1/link-verifier-0.1-linux64.tar.gz -O /tmp/link-verifier.tar.gz
  - tar -xvf /tmp/link-verifier.tar.gz
  - export PATH=$PATH:$PWD/link-verifier/

script:
  - ./link-verifier

Contribute!

It’s easy to contribute to this project. Install Go >= 1.11. Then run the following commands to get the source code, resolve external dependencies and build the project.

git clone https://github.com/bmuschko/link-verifier.git
cd link-verifier
go build
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].