https://github.com/articola-tools/markdown-linter

Preconfigured linter for Markdown files, used in Articola Tools organization's repositories
https://github.com/articola-tools/markdown-linter

articola articola-tools docker markdown markdown-linter

Last synced: 22 days ago
JSON representation

Preconfigured linter for Markdown files, used in Articola Tools organization's repositories

• Host: GitHub
• URL: https://github.com/articola-tools/markdown-linter
• Owner: Articola-Tools
• License: apache-2.0
• Created: 2024-10-14T11:49:39.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-19T16:07:06.000Z (about 2 months ago)
• Last Synced: 2024-11-19T17:19:57.586Z (about 2 months ago)
• Topics: articola, articola-tools, docker, markdown, markdown-linter
• Language: Dockerfile
• Homepage:
• Size: 25.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Articola Tools' Markdown linter

[![image size](https://ghcr-badge.egpl.dev/articola-tools/markdown-linter/size?color=dodgerblue)](https://ghcr-badge.egpl.dev/articola-tools/markdown-linter/size?color=dodgerblue)

This repo contains Dockerfile with preconfigured [Markdown linter](https://github.com/markdownlint/markdownlint).

This linter is used in Articola Tools organization's repositories to lint

Markdown files like README.md.

## Usage

Use `ghcr.io/articola-tools/markdown-linter` Docker image with `-v ./:/linter_workdir/repo`

parameter, where `./` - is a path to a folder with files you want to lint.

Example command to use this linter -

`docker run --rm -v ./:/linter_workdir/repo ghcr.io/articola-tools/markdown-linter`