WAI website theme

Pre-requisites

Before you begin, make sure you have the following installed:

Local build

After cloning the repository, run:

  git submodule update --init --remote
  bundle install
  bundle exec jekyll serve -w --config _config_doc.yml

Theme installation

Instructions

  1. Add the following to your Gemfile:

     # Plugin for building Jekyll with a GitHub-hosted theme
 gem 'jekyll-remote-theme', '~>0.4.3'

 # The WAI website theme
 gem 'wai-website-theme', '~>1.10'

  2. Add the following to your config.yml file:

       remote_theme: w3c/wai-website-theme

    Note: You can optionally specify a branch, tag, or commit to use by appending an @ and the Git ref. For example: w3c/wai-website-theme@1.9.10 or w3c/wai-website-theme@test-branch.

  3. List the theme plugins in your config.yml file:

     plugins:
   - jekyll-include-cache
   - jekyll-paginate
   - jekyll-redirect-from
   - jekyll-remote-theme
   - jekyll-seo-tag
   - jekyll-sitemap
   - wai-website-plugin

  4. Run Jekyll

    In your project root directory, run:

       bundle install
   bundle exec jekyll serve
Back to Top