From ee55f7204b08e62d2afab0bed21b0ab9dbe133c4 Mon Sep 17 00:00:00 2001 From: Chester How Date: Wed, 29 Mar 2017 12:55:29 +0800 Subject: [PATCH] Update readme --- README.md | 37 +++++++++++++++++++++++++-- _posts/2017-03-29-introducing-tale.md | 1 + 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ae9047b..e646f9a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,40 @@ # Tale -> Work in progress 🚧 +Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here](https://chesterhow.github.io/tale/). -Tale is a minimal Jekyll theme curated for storytellers. Checkout the [demo](https://chesterhow.github.io/tale/). +![Tale screenshot](http://i.imgur.com/pXZrtmo.png) + +## Features +- 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 + +## Usage +### 1. Fork and Clone +Fork this repository then clone it. + +### 2. Install dependencies +Tale uses Jekyll's built-SCSS compiler to generate CSS. You'll need to install the Jekyll gem: + +```bash +$ gem install jekyll +``` + +### 3. Create your site +Edit the `_config.yml` file to suit your site. Also replace posts and content with your own. + +### 4. Running Locally +To test your site locally, run this in your site's root directory + +```bash +$ jekyll serve --watch +``` + +Head to http://localhost: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! ## License See [LICENSE](https://github.com/chesterhow/tale/blob/master/LICENSE) diff --git a/_posts/2017-03-29-introducing-tale.md b/_posts/2017-03-29-introducing-tale.md index 8d579d5..e974662 100644 --- a/_posts/2017-03-29-introducing-tale.md +++ b/_posts/2017-03-29-introducing-tale.md @@ -7,6 +7,7 @@ author: "Chester" Tale is minimal [Jekyll](https://jekyllrb.com/) theme curated for storytellers. It is designed and developed by [myself](https://github.com/chesterhow/) for a friend who writes short stories. ## Tale features +- Compatible with GitHub Pages - Responsive design (looks just as good on mobile) - Syntax highlighting, with the help of Pygments - Markdown and HTML text formatting