Custom action for linting markdown files using mdformat.
Add the following workflow file to run the action:
# .github/workflows/mdformat.yml
name: Mdformat Action
on:
- pull_request
jobs:
mdformat:
name: Mdformat Action
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Mdformat Action
uses: ydah/mdformat-action@main
with:
number: true
env:
GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- File or Directory to do mdformat on.
- default:
.
- optional
- Apply consecutive numbering to ordered lists.
- default:
false
- optional
- Paragraph word wrap mode.
- keep
- no
- INTEGER
- default:
keep
- optional
- Output file line ending mode.
- lf
- crlf
- keep
- default:
lf
- optional
- Adding commit by autocorrect for mdformat.
- default:
false
- optional