From 26fe53fb6b55378c7af5cc39182c9188e57b10f1 Mon Sep 17 00:00:00 2001 From: Chester How Date: Tue, 9 Jan 2018 00:31:18 +0800 Subject: [PATCH] Update readme --- README.md | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 34ed470..e65de60 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,14 @@ Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here - Pagination of posts ## Installation - +### As a Jekyll theme 1. Add this line to your `Gemfile`: ```ruby gem "tale" ``` -2. And add this line to your `_config.yml`: +2. In `_config.yml` replace the `minima` theme with `tale`: ```yaml theme: tale @@ -27,13 +27,40 @@ theme: tale 3. Install the theme's gems and dependencies: - $ bundle +```bash +$ bundle +``` -4. Finally, build and serve your site +4. Rename `index.md` to `index.html`. Without this, the `jekyll-paginate` gem will not work. - $ bundle exec jekyll serve +5. Add these 2 lines in to `_config.yml`: -Head to http://localhost:4000/tale/ to see your site in action. +```yaml +permalink: /:year-:month-:day/:title +paginate: 5 +``` + +### As a Fork +1. Fork this repository + +2. Delete the unnecessary files/folders: `CODE_OF_CONDUCT.md`, `LICENSE`, `README.md`, `tale.gemspec` + +3. Delete the `baseurl` line in `_config.yml`: + +```yaml +baseurl: "/tale" # delete this line +``` + +## Usage +Once you've installed the theme, you're ready to work on your Jekyll site. To start off, I would recommend updating `_config.yml` with your site's details. + +To build and serve your site, run: + +```bash +$ bundle exec jekyll serve +``` + +And you're all set! Head over to http://127.0.0.1:4000/ to see your site in action. ## Contributing Found a bug or have a suggestion? Feel free to create an issue or make a pull request!