Skip to content

Fix findings by new html-proofer #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ralph-lange merged 2 commits into from
Sep 29, 2021
Merged

Fix findings by new html-proofer #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d3f4e0
Ignore missing alt attributes in img elements.
ralph-lange Sep 28, 2021
5aa48b7
Point more clearly to the cibuild script.
ralph-lange Sep 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,12 @@ It checks a broad set of points: internal and external links existence (alerting

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

You can run the following gem to tests the generated site.

```bash
bundle exec jekyll build
bundle exec htmlproofer ./_site
```

A utility script has also been included to run these checks in a CI system smoothly.
You can run `bundle exec jekyll build` followed by `bundle exec htmlproofer ./_site` to build and test the generated site.
However, note that a comprehensive configuration is required for the htmlproofer.
Therefore, we strongly suggest to run the utility script at

```bash
./scripts/cibuild
```

which is also used for CI.
2 changes: 1 addition & 1 deletion scripts/cibuild
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ IGNORE_HREFS=${IGNORE_HREFS:+$IGNORE_HREFS,}$(ruby -e "puts %w{

echo "Ignoring urls: " $IGNORE_HREFS
bundle exec jekyll build
bundle exec htmlproofer --check_html --http-status-ignore "429" --check-favicon --assume-extension --empty-alt-ignore --only-4xx --url-ignore $IGNORE_HREFS $@ ./_site
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