Mdlinks - Markdown cross-document links checker

Last update: Mar 19, 2022

Overview

mdlinks

This repository provides Go package, command-line tool, and a GitHub Action that can verify cross-document links in a collection of markdown files.

Code scans markdown files for domain-less links and checks if referenced files exist. For example, if a file “doc1.md” has a link with “../img.png” target, this tool will check whether the “img.png” file exists in a “doc1.md” file parent directory.

If a link references an existing markdown document and has a fragment part, this tool checks that such a link points to an existing markdown header, using the same rules of unique ID generating as GitHub markdown rendering.

For example, use the #table-of-contents link fragment to reference the “Table of Contents” header.

Command-line tool

Install it like:

go install github.com/artyom/mdlinks/cmd/[email protected]

GitHub Action

When using default settings (scan the repository root directory, look for *.md files), you can use this action like this:

on:
  push:
  pull_request:

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/[email protected]
      - uses: artyom/[email protected]

You can customize what directory to scan and which files to match:

- uses: artyom/[email protected]
  with:
    dir: 'docs'
    glob: '*.markdown'

Comments

mdlinks does not support two relative levels backwards

Hello,

I have this tree:

--main/docs/subfolder/readme.md
--main/docs/file1.md
--main/file2.md

In readme.md I have :

[test](../file1.md) and [test2](../../file2.md)

mdlinks reports:

main/docs/subfolder/readme.md: link "../../file2.md" points to a non-existing file

opened by NoxInmortus 4

Mdlinks - Markdown cross-document links checker

Related tags

Overview

mdlinks

Command-line tool

GitHub Action

You might also like...

A CLI markdown converter written in Go.

A markdown renderer package for the terminal

A markdown parser written in Go. Easy to extend, standard(CommonMark) compliant, well structured.

:triangular_ruler:gofmtmd formats go source code block in Markdown. detects fenced code & formats code using gofmt.

Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️

go-md2man - 转换 Markdown 为 man 手册内容

A PDF renderer for the goldmark markdown parser.

Markdown to Webpage app

Markdown Powered Graph API

Comments

mdlinks does not support two relative levels backwards

Owner

Artyom Pervukhin

Produces a set of tags from given source. Source can be either an HTML page, Markdown document or a plain text. Supports English, Russian, Chinese, Hindi, Spanish, Arabic, Japanese, German, Hebrew, French and Korean languages.

Convert Microsoft Word Document to Markdown

Online server tool to made markdown document.

🚩 TOC, zero configuration table of content generator for Markdown files, create table of contents from any Markdown file with ease.

Markdown - Markdown converter for golang

Mdfmt - A Markdown formatter that follow the CommonMark. Like gofmt, but for Markdown

pdf document generation library

Blackfriday: a markdown processor for Go

⚙️ Convert HTML to Markdown. Even works with entire websites and can be extended through rules.

Upskirt markdown library bindings for Go