|
1 | 1 | # pathofbuildingcommunity.github.io
|
2 | 2 | Offline build planner for Path of Exile
|
| 3 | + |
| 4 | +# Hydra |
| 5 | + |
| 6 | +Marketing site template for Jekyll. Browse through a [live demo](https://proud-alligator.cloudvent.net/). |
| 7 | +Increase the web presence of your brand with this configurable theme. |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +Hydra was made by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll. |
| 12 | + |
| 13 | +Find more templates, themes and step-by-step Jekyll tutorials at [CloudCannon Academy](https://learn.cloudcannon.com/). |
| 14 | + |
| 15 | +## Features |
| 16 | + |
| 17 | +* Contact form |
| 18 | +* Pre-built pages |
| 19 | +* Pre-styled components |
| 20 | +* Blog with pagination |
| 21 | +* Post category pages |
| 22 | +* Disqus comments for posts |
| 23 | +* Staff and author system |
| 24 | +* Configurable footer |
| 25 | +* Optimised for editing in [CloudCannon](http://cloudcannon.com/) |
| 26 | +* RSS/Atom feed |
| 27 | +* SEO tags |
| 28 | +* Google Analytics |
| 29 | + |
| 30 | +## Setup |
| 31 | + |
| 32 | +1. Add your site and author details in `_config.yml`. |
| 33 | +2. Add your Google Analytics and Disqus keys to `_config.yml`. |
| 34 | +3. Get a workflow going to see your site's output (with [CloudCannon](https://app.cloudcannon.com/) or Jekyll locally). |
| 35 | + |
| 36 | +## Develop |
| 37 | + |
| 38 | +Hydra was built with [Jekyll](http://jekyllrb.com/) version 3.3.1, but should support newer versions as well. |
| 39 | + |
| 40 | +Install the dependencies with [Bundler](http://bundler.io/): |
| 41 | + |
| 42 | +~~~bash |
| 43 | +$ bundle install |
| 44 | +~~~ |
| 45 | + |
| 46 | +Run `jekyll` commands through Bundler to ensure you're using the right versions: |
| 47 | + |
| 48 | +~~~bash |
| 49 | +$ bundle exec jekyll serve |
| 50 | +~~~ |
| 51 | + |
| 52 | +## Editing |
| 53 | + |
| 54 | +Hydra is already optimised for adding, updating and removing pages, staff, advice, company details and footer elements in CloudCannon. |
| 55 | + |
| 56 | +### Posts |
| 57 | + |
| 58 | +* Add, update or remove a post in the *Posts* collection. |
| 59 | +* The **Staff Author** field links to members in the **Staff** collection. |
| 60 | +* Documentation pages are organised in the navigation by category, with URLs based on the path inside the `_docs` folder. |
| 61 | +* Change the defaults when new posts are created in `_posts/_defaults.md`. |
| 62 | + |
| 63 | +### Contact Form |
| 64 | + |
| 65 | +* Preconfigured to work with CloudCannon, but easily changed to another provider (e.g. [FormSpree](https://formspree.io/)). |
| 66 | +* Sends email to the address listed in company details. |
| 67 | + |
| 68 | +### Staff |
| 69 | + |
| 70 | +* Reused around the site to save multiple editing locations. |
| 71 | +* Add `excluded_in_search: true` to any documentation page's front matter to exclude that page in the search results. |
| 72 | + |
| 73 | +### Navigation |
| 74 | + |
| 75 | +* Exposed as a data file to give clients better access. |
| 76 | +* Set in the *Data* / *Navigation* section. |
| 77 | + |
| 78 | +### Footer |
| 79 | + |
| 80 | +* Exposed as a data file to give clients better access. |
| 81 | +* Set in the *Data* / *Footer* section. |
0 commit comments