tale/README.md
2017-10-08 02:50:44 +08:00

1.1 KiB

Tale

Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo here.

Tale screenshot

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:

$ 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

$ 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