Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.42 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.42 KB

Features

  • Contact form
  • Pre-built pages
  • Pre-styled components
  • Blog with pagination
  • Post category pages
  • Disqus comments for posts
  • Staff and author system
  • Configurable footer
  • RSS/Atom feed
  • SEO tags

Setup

  1. Add your site and author details in _config.yml.
  2. Get a workflow going to see your site's output with Jekyll locally).

Develop

This page was built with Jekyll version 3.3.1, but should support newer versions as well.

Install the dependencies with Bundler:

$ bundle install

Run jekyll commands through Bundler to ensure you're using the right versions:

$ bundle exec jekyll serve

Posts

  • Add, update or remove a post in the Posts collection.
  • The Staff Author field links to members in the Staff collection.
  • Documentation pages are organised in the navigation by category, with URLs based on the path inside the _docs folder.
  • Change the defaults when new posts are created in _posts/_defaults.md.

Staff

  • Reused around the site to save multiple editing locations.
  • Add excluded_in_search: true to any documentation page's front matter to exclude that page in the search results.

Navigation

  • Exposed as a data file to give clients better access.
  • Set in the Data / Navigation section.

Footer

  • Exposed as a data file to give clients better access.
  • Set in the Data / Footer section.