Skip to content

Commit d9fd640

Browse files
authored
Fix findings by new html-proofer (#351)
* Ignore missing alt attributes in img elements. * Point more clearly to the cibuild script. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com>
1 parent dc83f4a commit d9fd640

2 files changed

Lines changed: 6 additions & 9 deletions

File tree

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,12 @@ It checks a broad set of points: internal and external links existence (alerting
5959

6060
To install it, It has been incorporated in the Gemfile so the previous dependency install command would have already installed it.
6161

62-
You can run the following gem to tests the generated site.
63-
64-
```bash
65-
bundle exec jekyll build
66-
bundle exec htmlproofer ./_site
67-
```
68-
69-
A utility script has also been included to run these checks in a CI system smoothly.
62+
You can run `bundle exec jekyll build` followed by `bundle exec htmlproofer ./_site` to build and test the generated site.
63+
However, note that a comprehensive configuration is required for the htmlproofer.
64+
Therefore, we strongly suggest to run the utility script at
7065

7166
```bash
7267
./scripts/cibuild
7368
```
69+
70+
which is also used for CI.

scripts/cibuild

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ IGNORE_HREFS=${IGNORE_HREFS:+$IGNORE_HREFS,}$(ruby -e "puts %w{
2929

3030
echo "Ignoring urls: " $IGNORE_HREFS
3131
bundle exec jekyll build
32-
bundle exec htmlproofer --check_html --http-status-ignore "429" --check-favicon --assume-extension --empty-alt-ignore --only-4xx --url-ignore $IGNORE_HREFS $@ ./_site
32+
bundle exec htmlproofer --check_html --http-status-ignore "429" --check-favicon --assume-extension --alt-ignore "/.*/" --empty-alt-ignore --only-4xx --url-ignore $IGNORE_HREFS $@ ./_site

0 commit comments

Comments
 (0)