Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 1.77 KB

README.md

File metadata and controls

55 lines (34 loc) · 1.77 KB
Raw

OntoPortal product and OntoPortal Alliance website

Setup

  1. Add your site and author details in _config.yml.
  2. Add your Google Analytics and Disqus keys to _config.yml.
  3. Get a workflow going to see your site's output (with CloudCannon or Jekyll locally).

Develop

OntoPortal product and OntoPortal Alliance website was built with Jekyll version 3.3.1 and the template Hydra, 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

Editing

Hydra is already optimised for adding, updating and removing pages, staff, advice, company details and footer elements in CloudCannon.

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.

Contact Form

  • Preconfigured to work with CloudCannon, but easily changed to another provider (e.g. FormSpree).
  • Sends email to the address listed in company details.

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.