tale/README.md
2018-01-08 20:23:56 +08:00

42 lines
931 B
Markdown

# Tale
Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here](https://chesterhow.github.io/tale/).
![Tale screenshot](http://i.imgur.com/pXZrtmo.png)
## Features
- Easy installation
- 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
## Installation
1. Add this line to your `Gemfile`:
```ruby
gem "tale"
```
2. And add this line to your `_config.yml`:
```yaml
theme: tale
```
3. Install the theme's gems and dependencies:
$ bundle
4. Finally, build and serve your site
$ bundle exec jekyll serve
Head to http://localhost:4000/tale/ 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!
## License
See [LICENSE](https://github.com/chesterhow/tale/blob/master/LICENSE)