README.md in jekyll-theme-prologue-0.2.4 vs README.md in jekyll-theme-prologue-0.2.5

- old
+ new

@@ -1,49 +1,56 @@ # Prologue - Jekyll Theme -## (Work in Progress, Expect Changes) +(Actively maintained, expect some changes) + [![Gem Version](https://badge.fury.io/rb/jekyll-theme-prologue.svg)](https://badge.fury.io/rb/jekyll-theme-prologue) ![Prologue Theme](assets/images/screenshot.png "Prologue Theme Screenshot") -A Jekyll version of the responsive, single-page "Prologue" theme by [HTML5 UP](https://html5up.net/). Perfect for a streamlined portfolio. +This is Prologue, a simple, single page responsive site template from [HTML5 UP](https://html5up.net/prologue), now available as a Jekyll theme from [Chris Bobbe](https://chrisbobbe.github.io). It features a clean, minimalistic design and a sticky sidebar with navigation-linked scrolling. **Demo**: https://chrisbobbe.github.io/jekyll-theme-prologue/ +# Added Features + +* **[Formspree.io](https://formspree.io/) contact form integration** - just add your email to the `_config.yml` and it works! +* Set a cover photo for any of your sections (not just the first), with alt text for screen readers and SEO +* Add your **social profiles** easily in `_config.yml`. Only the social profiles buttons you enter in `config.yml` will show up on the site footer. +* Search engine optimization (SEO) meta tags based on info you provide in `_config.yml` and frontmatter +* Google Analytics built-in; just put your [Tracking ID](https://support.google.com/analytics/answer/1008080?hl=en) in `_config.yml` as `google_analytics` +* Custom 404 page (called 404.html; to activate, move it to your project directory). + # How to Use There are two ways to get started: 1. **Install the [jekyll-theme-prologue gem](https://rubygems.org/gems/jekyll-theme-prologue).** Instructions are in the [Jekyll docs](https://jekyllrb.com/docs/themes/#installing-a-theme). After running `bundle install`, you can find the theme files by running `open $(bundle show jekyll-theme-prologue)`. A sample working `_config.yml` file ships with the gem; if you want to activate it, move it to your project's root directory. It will do nothing until you move it there, replacing the default `_config.yml` file. 2. **Fork the [GitHub repository](https://github.com/chrisbobbe/jekyll-theme-prologue).** If you want to use [GitHub Pages](https://pages.github.com/), create a branch named `gh-pages`, and replace `theme: jekyll-theme-prologue` with `remote_theme: chrisbobbe/jekyll-theme-prologue` in the provided `_config.yml` ([GitHub Pages now supports open-source themes on GitHub](https://github.com/blog/2464-use-any-theme-with-github-pages)). -Make sure that `url` and `base_url` are set correctly in `_config.yml`. For local testing, make them both blank. +Make sure that `url` and `base_url` are set for your own website in `_config.yml`. For local testing, make them both blank. -To set the banner image, overwrite `assets/images/banner.jpg`. If using the gem, you can add this path to your project directory by making new folders, and Jekyll will automatically look there before falling back on the default theme files. Same for `assets/images/avatar.jpg`. +Add a photo avatar to your project, then set `avatar: path/to/your/avatar.jpg` in _config.yml; for example, `avatar: assets/images/avatar.jpg`. 48x48 pixels works best. -**The following instructions are unique to this single-page theme. Jekyll does not support multiple layout-formatted content sections per page, and the theme provides a workaround.** +Set a cover photo in any of the sections by adding `cover-photo: path/to/photo.jpg` and `cover-photo-alt: some alt text` to the section's frontmatter. (Don't forget the alt text for screen readers; it won't work without it.) -You don't need to use Jekyll's hardcoded support for `_pages` or `_posts`, and layouts aren't provided for them. If you want to customize the templates, go to `_layouts/home.html` and `_includes/section.html` provided with the theme. +## Special instructions +Jekyll does not support multiple layout-formatted content sections per page, and this theme is a good workaround. **Bear with me for a few instructions unique to jekyll-theme-prologue.** -Your `_config.yml` file **must include the following line or it will not work**: `collections: [sections]`. This tells Jekyll to look in the _sections folder (which you will create) for your content and render it all on one page. +You don't need to use Jekyll's hardcoded support for `_pages` or `_posts`, and layouts aren't provided for them. If you want to customize the templates, go to `_layouts/home.html` and `_includes/section.html` provided with the theme, but this isn't necessary. -Create a `_sections` folder in your project's root directory and start adding content. Sample content is provided in the [GitHub repository](https://github.com/chrisbobbe/jekyll-theme-prologue). +1. **Your `_config.yml` file must include the following line or it will not work**: `collections: [sections]`. This tells Jekyll to look in the _sections folder (which you will create) for your content and render it all on one page. +2. **Create a `_sections` folder** in your project's root directory and start adding content. Sample content is provided in the [GitHub repository](https://github.com/chrisbobbe/jekyll-theme-prologue/tree/master/_sections). + All new sections should be added as html or Markdown documents in the `_sections` folder. The following variables can be set with [frontmatter](https://jekyllrb.com/docs/frontmatter/): - `title` (required) -- `order` (required; orders the sequence of sections on the page. Section 1 displays with banner.jpg) -- `icon` (optional; see [Font Awesome](http://fontawesome.io/icons/) for icon codes) +- `order` (required; orders the sequence of sections on the page. Example: `1`) +- `cover-photo` (optional; sets a background image for the section. Example: `assets/images/banner.jpg`) +- `cover-photo-alt` (required if using a cover photo. Describes the photo for screen readers; e.g., "Dome of Light art installation, Kaohsiung, Taiwan") +- `icon` (optional; see [Font Awesome](http://fontawesome.io/icons/) for icon codes. Example: `fa-github`) - `auto-header` (optional; "use-title" is default, "none" for no header, or custom header text) -There shouldn't be a need to set `permalink` in frontmatter because all content appears on the same page. - -# Added Features - -* **[Formspree.io](https://formspree.io/) contact form integration** - just add your email to the `_config.yml` and it works! -* Add your **social profiles** easily in `_config.yml`. Only the social profiles buttons you enter in `config.yml` will show up on the site footer. -* Custom 404 page (called 404.html; to activate, move to your project directory). -* Comprehensive search engine optimization (SEO) tags based on info you provide in _config.yml -* Google Analytics built-in; just put your [Tracking ID](https://support.google.com/analytics/answer/1008080?hl=en) in _config.yml +There shouldn't be a need to set `permalink` because all content displays together in `index.html`. # Credits Thanks to @andrewbanchich for his many Jekyll adaptations of HTML5 UP's elegant themes, which helped and inspired me, and of course many thanks to HTML5 UP.