mirror of
https://github.com/Redocly/redoc.git
synced 2024-12-02 13:23:44 +03:00
4fd22f6d74
* docs: add markdownlint and some link checks alongside vale * docs: add link checker config and fix/update some links reported broken * docs: update markdownlint action * docs: fix markdown table formatting * docs: Unpin Vale version and pick up the latest
38 lines
842 B
YAML
38 lines
842 B
YAML
name: Documentation tests
|
|
on:
|
|
pull_request:
|
|
types: [opened, synchronize, reopened]
|
|
|
|
jobs:
|
|
markdownlint:
|
|
name: markdownlint
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: DavidAnson/markdownlint-cli2-action@v15
|
|
with:
|
|
config: .markdownlint.yaml
|
|
globs: |
|
|
docs/**/*.md
|
|
README.md
|
|
|
|
vale:
|
|
name: vale action
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: errata-ai/vale-action@reviewdog
|
|
with:
|
|
files: '["README.md", "docs"]'
|
|
filter_mode: file
|
|
|
|
linkcheck:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout Repository
|
|
uses: actions/checkout@v4
|
|
- name: Markup Link Checker (mlc)
|
|
uses: becheran/mlc@v0.16.1
|
|
with:
|
|
args: ./docs
|