GitHub Actions Integration#

You can use gomarklint in your CI workflows using the official GitHub Action.

Note: It is recommended that you create a .gomarklint.json configuration file in your repository root before using gomarklint in GitHub Actions. If no configuration file is present, gomarklint will run with its default settings. You can generate a starter config with: gomarklint init

Example: .github/workflows/lint.yml#

name: Lint Markdown

on:
  push:
    paths:
      - '**/*.md'
  pull_request:
    paths:
      - '**/*.md'

jobs:
  markdown-lint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Run gomarklint Action
        uses: shinagawa-web/gomarklint-action@v1