Skip to content

Commit

Permalink
fix. Markdown linting
Browse files Browse the repository at this point in the history
  • Loading branch information
WebDucer committed Aug 1, 2024
1 parent 0bfe41d commit e4ac0a3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
6 changes: 6 additions & 0 deletions .markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
MD033:
# Allowed elements
allowed_elements:
- details
- summary
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ jobs:
excluded-files: '**/*.g.dart, **/*.freezed.dart, **/.realm.dart'
# Optional (default: 'true): Report coverage as step summary
step-summary: 'true'
# Optional (default: 'false): Reoprt coverage on PR (with update of the comment)
# Optional (default: 'false): Reoprt coverage on PR
# (with update of the comment)
pr-comment: 'true'
# Optional: GitHub token to write the PR comment (also requires premission to do so)
# Optional: GitHub token to write the PR comment
# (also requires premission to do so)
github-token: ${{ secrets.GITHUB_TOKEN }}

- name: Coverage output
Expand Down Expand Up @@ -59,7 +61,7 @@ report. Common globes can be used here:

Publish the coverage table to step summary (optional - default: `true`)

### `pr-comment`
#### `pr-comment`

Publish the coverage table as PR comment. On new push, the comment is updated
(optional - default: `false`)
Expand Down

0 comments on commit e4ac0a3

Please sign in to comment.