https://github.com/vweevers/hallmark-lint-action

A GitHub Action to lint markdown files with hallmark.
https://github.com/vweevers/hallmark-lint-action

annotations github-action hallmark lint markdown remark

Last synced: about 1 month ago
JSON representation

A GitHub Action to lint markdown files with hallmark.

• Host: GitHub
• URL: https://github.com/vweevers/hallmark-lint-action
• Owner: vweevers
• License: gpl-3.0
• Created: 2020-11-01T22:23:40.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2020-11-14T09:15:21.000Z (over 5 years ago)
• Last Synced: 2026-05-01T13:23:29.828Z (about 1 month ago)
• Topics: annotations, github-action, hallmark, lint, markdown, remark
• Language: JavaScript
• Homepage:
• Size: 494 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# hallmark-lint-action

**A [GitHub Action](https://github.com/features/actions) to lint markdown files with [`hallmark`](https://github.com/vweevers/hallmark).**

![GitHub tag](https://img.shields.io/github/v/tag/vweevers/hallmark-lint-action?sort=semver)

[![Markdown Style Guide](https://img.shields.io/badge/md_style-hallmark-brightgreen.svg)](https://github.com/vweevers/hallmark)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Usage

```yaml

- name: Checkout

  uses: actions/checkout@v2

- name: Markdown Style Guide

  uses: vweevers/hallmark-lint-action@v1

  with:

    token: ${{ secrets.GITHUB_TOKEN }}

```

## Example

![Example](example.png)

## Inputs

- `token` (required): GitHub token for creating status checks with annotations

- `files`: newline-separated glob patterns of files to lint, default is `*.md`.

Hallmark can be further configured via [`package.json` or `.hallmarkrc`](https://github.com/vweevers/hallmark).

## License

[GPL-3.0](LICENSE)