-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17 from gaurav-nelson/release0.5.0
Updated readme
- Loading branch information
Showing
1 changed file
with
23 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|