Skip to content

Commit

Permalink
Merge pull request #17 from gaurav-nelson/release0.5.0
Browse files Browse the repository at this point in the history
Updated readme
  • Loading branch information
Gaurav Nelson authored Feb 10, 2020
2 parents 703c232 + 3130706 commit 9d1134b
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,30 @@ This GitHub action checks all Markdown files in your repository for broken links
- uses: actions/checkout@master
with:
fetch-depth: 1
- uses: gaurav-nelson/[email protected]
- uses: gaurav-nelson/[email protected]
```
1. If you want to use a [custom configuration](https://github.com/tcort/markdown-link-check#config-file-format)
for markdown-link-check, or use the `--verbose` or `--quite` options, use the
`config-file`, `use-quite-mode`, and `use-verbose-mode` variables as follows:

```yml
name: Check Markdown links
on: push
jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
with:
fetch-depth: 1
- uses: gaurav-nelson/[email protected]
with:
use-quite-mode: 'yes'
use-verbose-mode: 'yes'
config-file: 'mlc_config.json'
```
1. To use a [custom configuration](https://github.com/tcort/markdown-link-check#config-file-format)
for markdown-link-check, create a JSON configuration file and save it in the
root folder as `mlc_config.json`.

## Test internal and external links

Expand Down

0 comments on commit 9d1134b

Please sign in to comment.