Update readme

This commit is contained in:
Chester How 2018-01-09 00:31:18 +08:00
parent 04309a0c99
commit 26fe53fb6b
1 changed files with 33 additions and 6 deletions

View File

@ -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!