README.md in alembic-jekyll-theme-1.2.1 vs README.md in alembic-jekyll-theme-1.5.0

- old
+ new

@@ -30,14 +30,17 @@ - Extensive set of shortcodes to include various elements; such as buttons, icons, figure images and more - Solid typographic framework from [Sassline](https://sassline.com/) - Configurable navigation via a single file - Modular Jekyll components - Easily interchangeable sidebar +- 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/) - Works on [GitHub Pages](https://pages.github.com/) out of the box - Built with [Jekyll](https://jekyllrb.com/) 3.3 - Designed with [Siteleaf](http://www.siteleaf.com/) in mind +- Has 9 of the most popular networks as performant sharing buttons - Has documentation ## Examples Here are a few examples of Alembic out in the wild being used in a variety of ways: @@ -122,10 +125,31 @@ Available options: - `id`: The reference for the icon _required_ - `title`: The accessible label for the icon - `color`: The desired colour of the icon +### `nav-share.html` +A set of buttons that share the current page to various social networks, which is controlled within the `_config.yml` file under the `sharing_links` keyword. + +Example usage: `{% include nav-share.html %}` + +Available options: +``` yml +Twitter: "#1DA1F2" +facebook: "#3B5998" +Google+: "#DC4E41" +Pinterest: "#BD081C" +LinkedIn: "#0077B5" +tumblr: "#36465D" +Reddit: "#FF4500" +Hacker News: "#ff6600" +Designer News: "#2D72D9" +Email: "" +``` + +_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._ + ### `video.html` A YouTube video. Example usage: `{% include video.html id="zrkcGL5H3MU" %}` @@ -145,15 +169,24 @@ 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. +### `site-search.html` +Adds a search form to the page. + +Example usage: `{% include site-search.html %}` + +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. + ## Page layouts As well as `page`, `post`, `blog`, there are a few alternative layouts that can be used on pages: - `page-aside-left`: Places the aside (sidebar) to the left of the content - `home`: Removes the aside entirely, leaving the full width for the main content (typically used for home page designs) +- `categories`: Shows all posts grouped by category, with an index of categories in a left hand sidebar +- `search`: Adds a search field to the page as well as a simplified version of the sidebar to allow more focus on the search results ## Page and Post options There are some more specific options you can apply when creating a page or a post: