diff --git a/Gemfile b/Gemfile index 9c3d901..20ca820 100644 --- a/Gemfile +++ b/Gemfile @@ -7,3 +7,5 @@ group :jekyll_plugins do gem 'jekyll-paginate' gem 'jekyll-autoprefixer' end + +gem "html-proofer", "~> 3.18" diff --git a/Gemfile.lock b/Gemfile.lock index 9e973de..76ffffe 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -86,6 +86,14 @@ GEM html-pipeline (2.11.1) activesupport (>= 2) nokogiri (>= 1.4) + html-proofer (3.18.8) + addressable (~> 2.3) + mercenary (~> 0.3) + nokogumbo (~> 2.0) + parallel (~> 1.3) + rainbow (~> 3.0) + typhoeus (~> 1.3) + yell (~> 2.0) http_parser.rb (0.6.0) i18n (0.9.5) concurrent-ruby (~> 1.0) @@ -212,12 +220,16 @@ GEM nokogiri (1.11.1) mini_portile2 (~> 2.5.0) racc (~> 1.4) + nokogumbo (2.0.4) + nokogiri (~> 1.8, >= 1.8.4) octokit (4.14.0) sawyer (~> 0.8.0, >= 0.5.3) + parallel (1.20.1) pathutil (0.16.2) forwardable-extended (~> 2.6) public_suffix (3.1.1) racc (1.5.2) + rainbow (3.0.0) rb-fsevent (0.10.3) rb-inotify (0.10.0) ffi (~> 1.0) @@ -243,12 +255,14 @@ GEM tzinfo (1.2.5) thread_safe (~> 0.1) unicode-display_width (1.6.0) + yell (2.2.2) PLATFORMS ruby DEPENDENCIES github-pages + html-proofer (~> 3.18) jekyll-autoprefixer jekyll-paginate jekyll-remote-theme diff --git a/README.md b/README.md index 4efd4df..fc0ec42 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ -# WIP: GFSC's Jekyll Boilerplate +# Resistance Lab Website -There are many boilerplates out there, but this is ours. +To run this locally -## Site setup list +``` +git clone https://github.com/Resistance-Lab/resistancelab_site +bundle +bundle exec jekyll serve --livereload +``` -1. Register domain name [and configure to use GHP](https://help.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site) -1. Create Google Analytics account and place key in `config.yml` -1. Create favicons and touch icons using [favicon generator](https://realfavicongenerator.net/) -1. Create OG images at 2:1 and 1:1 ratios. Make sure they're linked properly in `includes/meta.html`. +## Tests + +There is a small test suite to validate pages and check links work. To run it: + +``` +rake test +``` diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..d276396 --- /dev/null +++ b/Rakefile @@ -0,0 +1,13 @@ +require 'html-proofer' + +task :test do + sh "bundle exec jekyll build" + options = { + assume_extension: true, + check_favicon: true, + check_opengraph: true, + check_html: true, + empty_alt_ignore: true + } + HTMLProofer.check_directory("./_site", options).run +end