README.md

IRIDA Documentation

This is the repository for the IRIDA documenation GitHub pages site. View the documentation pages at https://phac-nml.github.io/irida-documentation/. For the main IRIDA repository, see https://github.com/phac-nml/irida/.

Running the pages locally

GitHub Pages uses Jekyll to generate IRIDA's documentation. You can run Jekyll locally to verify your documentation changes locally before pushing to GitHub.

• Ensure Ruby is installed. https://www.ruby-lang.org/en/downloads/
• Install bundler

gem install bundler

• Install Jekyll from the Gemfile in the /docs subdirectory

# from the docs directory
bundle install

• Run Jekyll from the docs directory

# from the docs directory
bundle exec jekyll serve