From e4ac0a32726bceac82d92eb60bd27e94b0cb48b7 Mon Sep 17 00:00:00 2001 From: "Eugen [WebDucer] Richter" Date: Thu, 1 Aug 2024 09:40:46 +0200 Subject: [PATCH] fix. Markdown linting --- .markdown-lint.yml | 6 ++++++ README.md | 8 +++++--- 2 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 .markdown-lint.yml diff --git a/.markdown-lint.yml b/.markdown-lint.yml new file mode 100644 index 0000000..093c42e --- /dev/null +++ b/.markdown-lint.yml @@ -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 diff --git a/README.md b/README.md index a117f3b..e2a40df 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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`)