{"id":15288510,"url":"https://github.com/floppy/jekyll-test","last_synced_at":"2025-04-13T06:43:11.242Z","repository":{"id":55122492,"uuid":"100595205","full_name":"Floppy/jekyll-test","owner":"Floppy","description":"A highly opinionated test configuration for Jekyll sites","archived":false,"fork":false,"pushed_at":"2022-07-12T09:07:04.000Z","size":99,"stargazers_count":21,"open_issues_count":2,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-09T14:08:50.689Z","etag":null,"topics":["jekyll","rake","static-site-generator","testing"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Floppy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-17T11:14:40.000Z","updated_at":"2023-08-06T06:25:04.000Z","dependencies_parsed_at":"2022-08-14T12:40:34.925Z","dependency_job_id":null,"html_url":"https://github.com/Floppy/jekyll-test","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Floppy%2Fjekyll-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Floppy%2Fjekyll-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Floppy%2Fjekyll-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Floppy%2Fjekyll-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Floppy","download_url":"https://codeload.github.com/Floppy/jekyll-test/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248675445,"owners_count":21143764,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jekyll","rake","static-site-generator","testing"],"created_at":"2024-09-30T15:49:49.865Z","updated_at":"2025-04-13T06:43:11.202Z","avatar_url":"https://github.com/Floppy.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jekyll-Test\n\n`jekyll-test` is a highly opinionated test configuration for Jekyll sites to let you create well-formed sites with minimal configuration, built on top of [html-proofer](https://github.com/gjtorikian/html-proofer).\n\nIt provides two rake tasks:\n\n`jekyll:check` will test your site for HTML validity, internal link correctness, alt tags, OpenGraph validity, https usage, and a load more. It will complain about as much as it can. You want this to pass.\n\n`jekyll:check_external_links` will check all outgoing links as well. This is a separate task as this often fails due to network errors, etc, and you don't want to depend on it passing. Use it for information only.\n\n## Requirements\n\n* Ruby 2.5 or higher (`ruby -v` to check version)\n* Bundler (`gem install bundler` if it's not there)\n\n## Usage\n\nAdd `jekyll-test` to your site's `Gemfile` (or just create the file with the following content if it doesn't exist) and run `bundle`:\n\n```ruby\nsource \"https://rubygems.org\"\n\ngem 'rake'\ngem 'github-pages'\n\ngroup :test do\n  gem 'jekyll-test'\nend\n```\n\nThen add this to `Rakefile` (or create a file with just this in it if you don't have one):\n\n```ruby\nrequire 'jekyll/test/tasks'\n```\n\nWe suggest making `jekyll:check` your default task by adding this line to `Rakefile` as well:\n\n```rake\ntask default: \"jekyll:check\"\n```\n\nYou can then run `rake` and bingo, your site will be tested with `html-proofer`.\n\n### Travis configuration\n\nTo configure a travis build to run these tests, run:\n\n```\ngem install travis\nrake jekyll:configure:travis\n```\n\nThis will initialise your repo for use on travis, if necessary, then write a multi-build configuration which will run both checks together. The link check is allowed to fail, so it will not impact your CI success / failure.\n\nWARNING: This will aggressively overwrite bits of `.travis.yml`, so if you already have one, make sure it's committed or backed up so you can check the changes.\n\nIt's a good idea to run the task with each new release of this gem to get the latest configuration.\n\n## Coming soon\n\n* spellchecking\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/Floppy/jekyll-test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## Code of Conduct\n\nEveryone interacting in the Jekyll::Test project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-test/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffloppy%2Fjekyll-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffloppy%2Fjekyll-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffloppy%2Fjekyll-test/lists"}