The gomarklint is a command-line Markdown linter designed to detect formatting issues and inconsistencies in Markdown files. It checks document structure and helps keep Markdown content clean for documentation, and repositories. This tutorial demonstrates how to install gomarklint on Ubuntu 26.04.
Install gomarklint
Download the latest gomarklint archive from the GitHub releases page and extract executable into /usr/local/bin:
curl -sSL https://github.com/shinagawa-web/gomarklint/releases/latest/download/gomarklint_Linux_x86_64.tar.gz \
| sudo tar xz -C /usr/local/bin gomarklint
After the installation finishes, confirm that gomarklint has been installed correctly by checking the version:
gomarklint --version
Testing gomarklint
Create a sample Markdown file to test the linter and verify that it detects formatting problems:
nano test.md
Add the following content:
## Project Title
#### Installation
Run gomarklint against the file:
gomarklint test.md
Example output:
Errors in test.md:
test.md:3: [error] Heading level jumped from 2 to 4
The warning indicates that the heading structure contains a level jump, where a level 4 heading appears immediately after a level 2 heading.
Uninstall gomarklint
If gomarklint is no longer required, remove the installed binary from the system:
sudo rm -rf /usr/local/bin/gomarklint
Leave a Comment
Cancel reply