tale/README.md

43 lines
931 B
Markdown
Raw Normal View History

2017-03-27 12:25:56 +00:00
# Tale
2017-03-29 04:55:29 +00:00
Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here](https://chesterhow.github.io/tale/).
2017-03-29 04:55:29 +00:00
![Tale screenshot](http://i.imgur.com/pXZrtmo.png)
## Features
2018-01-08 12:23:56 +00:00
- Easy installation
2017-03-29 04:55:29 +00:00
- Compatible with GitHub Pages
- Responsive design (looks just as good on mobile)
- Syntax highlighting, with the help of Pygments
- Markdown and HTML text formatting
- Pagination of posts
2018-01-08 12:23:56 +00:00
## Installation
2017-03-29 04:55:29 +00:00
2018-01-08 12:23:56 +00:00
1. Add this line to your `Gemfile`:
2017-03-29 04:55:29 +00:00
2018-01-08 12:23:56 +00:00
```ruby
gem "tale"
2017-03-29 04:55:29 +00:00
```
2018-01-08 12:23:56 +00:00
2. And add this line to your `_config.yml`:
2017-03-29 04:55:29 +00:00
2018-01-08 12:23:56 +00:00
```yaml
theme: tale
2017-03-29 04:55:29 +00:00
```
2018-01-08 12:23:56 +00:00
3. Install the theme's gems and dependencies:
$ bundle
4. Finally, build and serve your site
$ bundle exec jekyll serve
2017-10-07 18:50:44 +00:00
Head to http://localhost:4000/tale/ to see your site in action.
2017-03-29 04:55:29 +00:00
## Contributing
Found a bug or have a suggestion? Feel free to create an issue or make a pull request!
2017-03-27 12:25:56 +00:00
## License
See [LICENSE](https://github.com/chesterhow/tale/blob/master/LICENSE)