README.md in alembic-jekyll-theme-3.1.0 vs README.md in alembic-jekyll-theme-4.0.0

- old
+ new

@@ -23,16 +23,16 @@ - [Page and Post options](#page-and-post-options) - [Credits](#credits) ## About -**Alembic is a starting point for [Jekyll](https://jekyllrb.com/) projects. Rather than starting from scratch, this boilerplate theme is designed to get the ball rolling immediately. Install it, configure it, tweak it, push it.** +**Alembic is a starting point for [Jekyll](https://jekyllrb.com/) projects. Rather than starting from scratch, this boilerplate theme is designed to get rolling immediately. Install it, configure it, tweak it, push it.** ## Features - Available as a **theme gem** and **GitHub Pages** theme -- Simple and elegant design that can be used out of the box or as solid starting point +- Clear and elegant design that can be used out of the box or as solid starting point - Tested in all major browsers, including **IE and Edge** - Built in **Service Worker** so it can work offline and on slow connections - **Configurable colours** and typography in a single settings file - Extensive set of **shortcodes** to include various elements; such as buttons, icons, figure images and more - Solid **typographic framework** from [Sassline](https://sassline.com/) @@ -47,19 +47,13 @@ ## Examples Here are a few examples of Alembic out in the wild being used in a variety of ways: -- [bitpodcast.com](https://bitpodcast.com/) -- [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/) -- [ccs17.bsc.es](https://ccs17.bsc.es/) -- [karateca.org](http://www.karateca.org/) -- [p-recs.github.io](https://p-recs.github.io/2018/) +- [case2111.github.io](https://case2111.github.io/) +- [karateca.org](https://www.karateca.org/) ## Installation ### Quick setup @@ -72,10 +66,12 @@ [![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)** +- Stackbit starter kit: + [![Create with Stackbit](https://assets.stackbit.com/badge/create-with-stackbit.svg)](https://app.stackbit.com/create?theme=https://github.com/daviddarnes/alembic-stackbit-kit) ### 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 @@ -130,13 +126,13 @@ ### Site performance settings Alembic comes with a couple of options to enhance the speed and overall performance of the site you build upon it. -By default the built in Service Worker is enabled, and will work on a 'network first' method. That is, if there is no internet connection then the content the Service Worker has cached will be used until the connection comes back. It will always look for a live version of the code first. To disable the Service Worker set an option called `service_worker` to false in the `/_config.yml`. +By default the built in Service Worker is enabled, and will work on a 'network first' method. Meaning if there's no internet connection the content the Service Worker has cached will be used until the connection comes back. It will always look for a live version of the code first. To disable the Service Worker add an option called `service_worker` with a value of `false` in the `/_config.yml` file. -Another option to speed up Alembic is to enable inline CSS, which is off by default. You can enable this by setting `css_inline: true` inside your `/_config.yml` file. +Another option to speed up Alembic is to enable inline CSS, which is off by default. You can enable this by setting `css_inline: true` inside your `/_config.yml` file. By switching to inline styles you bypass the use `/assets/styles.scss`, any custom styles will need to be added in `/_includes/site-styles.html` or in a new custom file. Please note that these options aren't a "silver bullet" for making your site faster, make sure to audit and debug your site to get the best performance for your situation. ### Site navigation @@ -147,11 +143,11 @@ - `social_links`: The social icon links that are shown in the sidebar - `sharing_links`: The social sharing buttons that are shown at the bottom of blog posts All navigations can be edited using the `_config.yml` file. To see example usage either look for the `Site navigation` comment within the `/_config.yml` file or see [the nav-share.html include](#nav-sharehtml). -If there are no items for the `navigation_header` or `navigation_footer`, they will fallback to a list of pages within the site. The `social_navigation` properties should either be one that is already in the list (so `Twitter` or `Facebook`) or simply `link`, this is so an icon can be set for the link. +If there are no items for the `navigation_header` or `navigation_footer`, they will fallback to a list of pages within the site. The `social_navigation` properties should either be one that is already in the list (so `Twitter` or `Facebook`) or a regular `link`, this is so an icon can be set for the link. ## Using includes There are 2 main types of includes: ones designed for the site and ones that are designed as shortcodes. Here are a list of the shortcode includes: @@ -204,11 +200,11 @@ HackerNews: "#ff6600" DesignerNews: "#2D72D9" Email: true ``` -_The first item is the name of the network (must be one of the ones stated above) and the second is the colour of the button. To remove a button just remove the line of the same name._ +_The first item is the name of the network (must be one of the ones stated above) and the second is the colour of the button. To remove a button remove the line of the same name._ ### `video.html` A YouTube video. Example usage: `{% include video.html id="zrkcGL5H3MU" %}` @@ -244,10 +240,10 @@ This include has no options. This include will add a block of javascript to the page and javascript reference in order for the search field to work correctly. ### `site-before-start.html` & `site-before-end.html` Optional html includes for adding scripts, css, js or any embed code you wish to add to every page without the need to overwrite the entire `default.html` template. -**Example usage:** These are different to other includes as they are designed to be overwritten. If you create a `site-before-start.html` file in the `_includes/` the contents of the file will be included just before the closing `</head>` tag. If you create a `site-before-end.html` file the contents of the file will be included just before the closing `</body>` tag. +**Example usage:** These are different to other includes as they are designed to be overwritten. If you create a `site-before-start.html` file in the `_includes/` the contents of the file will be included immediately before the closing `</head>` tag. If you create a `site-before-end.html` file the contents of the file will be included immediately before the closing `</body>` tag. ## Page layouts As well as `page`, `post`, `blog`, there are a few alternative layouts that can be used on pages: