Skip to content

Commit

Permalink
proofread
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisbobbe committed Jan 8, 2018
1 parent 79c935f commit 9e64e59
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 20 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ A Jekyll version of the responsive, single-page "Prologue" theme by [HTML5 UP](h

There are two ways to get started:

1. 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`. (NOTE: The _config.yml file in this repository has `baseurl` set for my own GitHub Pages site, so you'll probably want to make it blank.)
1. 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`. (NOTE: The _config.yml file in this repository has `baseurl` set for my own GitHub Pages site, so you'll want to change it or make it blank.)
2. Install the theme using the jekyll-theme-prologue gem. Instructions can be found [here](https://jekyllrb.com/docs/themes/#installing-a-theme).

> Your `_config.yml` file **must include the following line or it will not work**: `collections: [sections]`. An optional sample config called `_sample-config.yml` ships with the gem for your convenience. If using the gem, run `open $(bundle show jekyll-theme-prologue)` to find this file, then move it to your project directory. It will do nothing until it's renamed `_config.yml` and sits in your project's root directory.
**The following instructions apply to this theme only.**

Your `_config.yml` file **must include the following line or it will not work**: `collections: [sections]`. An optional sample config called `_sample-config.yml` ships with the gem for your convenience. If using the gem, run `open $(bundle show jekyll-theme-prologue)` to find this file, then move it to your project directory. It will do nothing until it's renamed `_config.yml` and sits in your project's root directory.

Create a `_sections` folder in your project's root directory, or use the one provided in the GitHub repository, and start adding content.

Expand Down
21 changes: 3 additions & 18 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,4 @@
# Developer's Note: This is a sample _config.yml file offered with
# jekyll-theme-prologue for your convenience. To use it, move it to your
# project's root directory and rename it _config.yml. Please note that
# none of this code is necessary for runtime EXCEPT the lines
#
# theme: jekyll-theme-prologue
# collections: [sections]
#
# which activate the theme and tell Jekyll to find your content
# in /_sections. Note where "sections" starts with an underscore
# and where it doesn't. The social settings will make links to
# Twitter, etc. -- Chris Bobbe
#
# ---------------------------------------------------------------
#
# Welcome to Jekyll!
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
Expand All @@ -34,8 +19,8 @@ description: >- # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
# You may want baseurl to be blank:
baseurl: "" # the subpath of your site, e.g. /blog
# You'll want to change the baseurl; I've customized it for GitHub Pages:
baseurl: "/jekyll-theme-prologue" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site

author: Your Incredible-Name
Expand Down

0 comments on commit 9e64e59

Please sign in to comment.