https://github.com/zdharma-continuum/zdharma-continuum.github.io
https://github.com/zdharma-continuum/zdharma-continuum.github.io
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zdharma-continuum/zdharma-continuum.github.io
- Owner: zdharma-continuum
- License: other
- Created: 2021-11-08T12:32:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T07:19:35.000Z (7 months ago)
- Last Synced: 2025-01-13T14:19:19.772Z (5 months ago)
- Language: HTML
- Size: 5.49 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tale
[](https://badge.fury.io/rb/tale)
Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here](https://chesterhow.github.io/tale/).
## 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
There are 3 ways to install this theme
1. Install it as a Ruby Gem (for self-hosted sites)
1. Install it with the `jekyll-remote-theme` plugin (for GitHub Pages hosted sites)
1. Fork the project directly
### Ruby Gem method
1. Add this line to your `Gemfile`:
```ruby
gem "tale"
```
2. Install the theme's gems and dependencies:
```bash
$ bundle
```
3. In `_config.yml` add these lines:
```yaml
theme: tale
permalink: /:year-:month-:day/:title
paginate: 5
```
Remove any other `theme:` lines.
4. Rename `index.md` to `index.html`. Without this, the `jekyll-paginate` gem will not work.
1. In `about.md`, change the `layout:` field to `post`:
```Markdown
layout: post
```
### GitHub Pages method
1. Add these 2 lines in to your `Gemfile`:
```ruby
gem "jekyll-remote-theme"
gem "jekyll-paginate"
```
2. Install the newly added gems:
```bash
$ bundle
```
3. In `_config.yml` add these lines:
```yaml
remote_theme: chesterhow/tale
permalink: /:year-:month-:day/:title
paginate: 5
plugins:
- jekyll-paginate
- jekyll-remote-theme
```
Remove any other `theme:` or `remote_theme:` lines.
4. Rename `index.md` to `index.html`. Without this, the `jekyll-paginate` gem will not work.
1. In `about.md`, change the `layout:` field to `post`:
```Markdown
layout: post
```
### Fork method
1. Fork this repository
1. Delete the unnecessary files/folders: `CODE_OF_CONDUCT.md`, `LICENSE`, `README.md`, `tale.gemspec`
1. Delete the `baseurl` line in `_config.yml`:
```yaml
baseurl: /tale # delete this line
```
## Usage
Once you've installed the theme, you're ready to work on your Jekyll site. To start off, I would recommend updating
`_config.yml` with your site's details.
To build and serve your site, run:
```bash
$ bundle exec jekyll serve
```
And you're all set! Head over to http://127.0.0.1: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)