Skip to content

Commit

Permalink
proofread
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisbobbe committed Jan 11, 2018
1 parent c9d3935 commit b02d81e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ Add a photo avatar to your project, then set `avatar: path/to/your/avatar.jpg` i

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.)

**The following instructions are unique to this single-page theme. Jekyll does not support multiple layout-formatted content sections per page, and this theme is a good workaround.**
## 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 this theme.

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.

Expand All @@ -42,7 +43,7 @@ You don't need to use Jekyll's hardcoded support for `_pages` or `_posts`, and l

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)
- `order` (required; orders the sequence of sections on the page.)
- `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)
Expand Down

0 comments on commit b02d81e

Please sign in to comment.