Skip to content

Commit bc9bde0

Browse files
committed
Add testing instructions
1 parent b6d556a commit bc9bde0

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,27 @@ After installing Jekyll, install all dependencies by running
1818
bundle install
1919
```
2020

21+
## Testing generated site
22+
23+
To test the generated HTML site, you can use `html-proofer` gem.
24+
This Ruby gem checks and validates the jekyll generated HTML files.
25+
It checks a broad set of points: internal and external links existence (alerting of possible 404 errors), HTML attributes of the images and so on.
26+
27+
To install it, It has been incorporated in the Gemfile so the previous dependency install command would have already installed it.
28+
29+
You can run the following gem to tests the generated site.
30+
31+
```bash
32+
bundle exec jekyll build
33+
bundle exec htmlproofer ./_site
34+
```
35+
36+
A utility script has also been included to run these checks in a CI system smoothly.
37+
38+
```bash
39+
./scripts/cibuild
40+
```
41+
2142
## License
2243

2344
Released under [the Apache Public License 2.0](LICENSE).

0 commit comments

Comments
 (0)