@shinagawa-web/gomarklint
v3.3.0
Published
A fast, extensible Markdown linter written in Go
Maintainers
Readme
gomarklint
A fast, opinionated Markdown linter. Built in Go, designed for CI.
- Catch broken links and headings before your docs ship.
- Enforce predictable structure (no more "why is this H4 under H2?").
- Output that's friendly for both humans and machines (JSON).
- Process 100,000+ lines in ~170ms — fast enough for local dev, robust enough for CI.
Installation
npm install -g @shinagawa-web/gomarklintThe postinstall script automatically downloads the correct binary for your platform.
Supported platforms
| OS | x64 | arm64 | |---------|-----|-------| | macOS | o | o | | Linux | o | o | | Windows | o | o |
Usage
# Lint all Markdown files in current directory
gomarklint
# Lint specific files
gomarklint README.md docs/**/*.md
# Output as JSON
gomarklint --format jsonDocumentation
Full documentation is available at shinagawa-web.github.io/gomarklint
Other installation methods
- Shell:
curl -fsSL https://raw.githubusercontent.com/shinagawa-web/gomarklint/main/install.sh | sh - Homebrew:
brew install shinagawa-web/tap/gomarklint - Go:
go install github.com/shinagawa-web/gomarklint@latest - Binary: Download from GitHub Releases
License
MIT License
