40 lines
1.1 KiB
Markdown
40 lines
1.1 KiB
Markdown
# Tale
|
|
Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here](https://chesterhow.github.io/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
|
|
- 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/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)
|