README.md in alembic-jekyll-theme-3.0.3 vs README.md in alembic-jekyll-theme-3.0.4

- old
+ new

@@ -38,11 +38,11 @@ - Solid **typographic framework** from [Sassline](https://sassline.com/) - Configurable navigation via a single file - Modular Jekyll components - Post category support in the form of a single post index page grouped by category - Built in live search using JavaScript -- **Contact form** built in using [Formspree](https://formspree.io/) +- **Contact form** built in using [Formspree](https://formspree.io/) or [Netlify Forms](https://www.netlify.com/features/#forms) - Designed with **[Siteleaf](http://www.siteleaf.com/)** in mind - Has 9 of the most popular networks as performant sharing buttons - Has documentation ## Examples @@ -53,17 +53,26 @@ - [joelcagedesign.com](https://joelcagedesign.com/) - [bawejakunal.github.io](https://bawejakunal.github.io/) - [case2111.github.io](http://case2111.github.io/) - [www.10people.co.uk](http://www.10people.co.uk/) - [hrkeni.me](http://hrkeni.me/) -- [venuthatikonda.github.io](https://venuthatikonda.github.io/) - [ccs17.bsc.es](https://ccs17.bsc.es/) - [karateca.org](http://www.karateca.org/) - [p-recs.github.io](https://p-recs.github.io/2018/) ## Installation +### Quick setup + +To give you a running start I've put together some starter kits that you can download, fork or even deploy immediately: + +- Vanilla Jekyll starter kit - [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/daviddarnes/alembic-kit) +- Forestry starter kit - [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/daviddarnes/alembic-forestry-kit) +- Netlify CMS starter kit - [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/daviddarnes/alembic-netlifycms-kit&stack=cms) + +- GitHub Pages with remote theme kit - **[Download kit](https://github.com/daviddarnes/alembic-kit/archive/remote-theme.zip)** + ### As a Jekyll theme 1. Add `gem "alembic-jekyll-theme"` to your `Gemfile` to add the theme as a dependancy 2. Run the command `bundle install` in the root of project to install the theme and its dependancies 3. Add `theme: alembic-jekyll-theme` to your `_config.yml` file to set the site theme @@ -94,11 +103,11 @@ When using Alembic as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, simply by matching the file name and path. The most common example of this would be if you want to add your own styles or change the core style settings. To add your own styles copy the [`styles.scss`](https://github.com/daviddarnes/alembic/blob/master/assets/styles.scss) into your own project with the same file path (`assets/styles.scss`). From there you can add your own styles, you can even optionally ignore the theme styles by removing the `@import "alembic";` line. -If you're just looking to set your own colours and fonts copy the [`_settings.scss`](https://github.com/daviddarnes/alembic/blob/master/_sass/_settings.scss) file into your project at the same file path (`_sass/_settings.scss`) and change variables however you wish. The settings are a mixture of custom variables and settings from [Sassline](https://medium.com/@jakegiltsoff/sassline-v2-0-e424b2881e7e) - follow the link to find out how to configure the typographic settings. +If you're just looking to set your own colours and fonts copy the [`_settings.scss`](https://github.com/daviddarnes/alembic/blob/master/_sass/_settings.scss) and main theme styles file [`alembic.scss`](https://github.com/daviddarnes/alembic/blob/master/_sass/alembic.scss) into your project at the same file path (`_sass/`) and change variables however you wish. The settings are a mixture of custom variables and settings from [Sassline](https://medium.com/@jakegiltsoff/sassline-v2-0-e424b2881e7e) - follow the link to find out how to configure the typographic settings. ## Configuration There are a number of optional settings for you to configure. Use the example [`_config.yml`](https://github.com/daviddarnes/alembic/blob/master/_config.yml) file in the repo and use the documentation below to configure your site: @@ -208,14 +217,19 @@ Available options: - `id`: The map ID for the video _required_ ### `site-form.html` -Adds a contact form to the page. +Adds a contact form to the page. This can be used with [Formspree](https://formspree.io/) or [Netlify Forms](https://www.netlify.com/docs/form-handling/) depending on your setup. Example usage: `{% include site-form.html %}` -This include has no options. Use the `email` option in the `/_config.yml` to change to the desired email. +Available options: +- `netlify_form=true`: Set whether you would like to use Netlify Forms, otherwise the form will default to Formspree +- `name`: Give the form a name, by default the form is called "Contact". The name will be reflected when form submissions come through in Netlify or in your email client. The name is also used in the label and input elements for accessibility + + +Use the `email` option in the `/_config.yml` to change to the desired email. ### `site-search.html` Adds a search form to the page. Example usage: `{% include site-search.html %}`