Update readme
This commit is contained in:
parent
017bb96b9b
commit
ee55f7204b
2 changed files with 36 additions and 2 deletions
37
README.md
37
README.md
|
@ -1,7 +1,40 @@
|
||||||
# Tale
|
# 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
|
## License
|
||||||
See [LICENSE](https://github.com/chesterhow/tale/blob/master/LICENSE)
|
See [LICENSE](https://github.com/chesterhow/tale/blob/master/LICENSE)
|
||||||
|
|
|
@ -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 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
|
## Tale features
|
||||||
|
- Compatible with GitHub Pages
|
||||||
- Responsive design (looks just as good on mobile)
|
- Responsive design (looks just as good on mobile)
|
||||||
- Syntax highlighting, with the help of Pygments
|
- Syntax highlighting, with the help of Pygments
|
||||||
- Markdown and HTML text formatting
|
- Markdown and HTML text formatting
|
||||||
|
|
Loading…
Reference in a new issue