mirror of
https://github.com/metagov/govarch-website.git
synced 2025-04-30 21:28:01 +00:00
110 lines
3.9 KiB
Markdown
110 lines
3.9 KiB
Markdown
# Hitchens
|
|
|
|
|
|
|
|
An inarguably well-designed Jekyll theme.
|
|
|
|
Undoubtably one of the great minds of our time, [Christopher Hitchens](https://en.wikipedia.org/wiki/Christopher_Hitchens) challenged his readers to think deeply on topics of politics, religion, war, and science. This Jekyll theme's design is inspired by the trade paperback version his book, [Arguably](https://en.wikipedia.org/wiki/Arguably), and is dedicated to his memory.
|
|
|
|
## Installation
|
|
|
|
Add this line to your Jekyll site's `Gemfile`:
|
|
|
|
```ruby
|
|
gem "hitchens-theme"
|
|
```
|
|
|
|
And add this line to your Jekyll site's `_config.yml`:
|
|
|
|
```yaml
|
|
theme: hitchens-theme
|
|
```
|
|
|
|
And then execute:
|
|
|
|
$ bundle
|
|
|
|
Or install it yourself as:
|
|
|
|
$ gem install hitchens-theme
|
|
|
|
## Usage
|
|
|
|
### Home Layout
|
|
|
|
The `home` layout presents a list of articles ordered chronologically. All articles are presented in one page, similar to a book's table of contents.
|
|
|
|
The masthead of the home page is derived from the `title` and `description` set in your site's `_config.yml` file.
|
|
|
|
#### Navigation
|
|
|
|
To include navigation in your site's masthead:
|
|
|
|
1. Create a `_data` directory in the root of your site.
|
|
2. Add a `menu.yml` file to the `_data` directory.
|
|
3. Use the following format to list your menu items:
|
|
|
|
```
|
|
- title: About
|
|
url: /about
|
|
```
|
|
|
|
Be sure to start your `url`s with a `/`.
|
|
|
|
## Pagination
|
|
|
|
To paginate your posts, add the following line to your site's `Gemfile`:
|
|
|
|
```
|
|
gem "jekyll-paginate"
|
|
```
|
|
|
|
Then, add the following lines to your site's `_config.yml` file:
|
|
|
|
```
|
|
plugins:
|
|
- jekyll-paginate
|
|
|
|
paginate: 20
|
|
paginate_path: "/page/:num/"
|
|
```
|
|
|
|
You can set the `paginate` and `paginate_path` settings to whatever best suits you.
|
|
|
|
### Post Layout
|
|
|
|
A sparsely decorated layout designed to present long-form writing in a manner that's pleasing to read.
|
|
|
|
### Credits
|
|
|
|
The theme credits that appear at the bottom of each page can be turned off by including the following line in your site's `_config.yml` file:
|
|
|
|
```
|
|
hide_credits: true
|
|
```
|
|
|
|
### Font
|
|
|
|
I spent a good amount of time trying to identify the font used on the front cover of the trade paperback version of Arguably. Unfortunately, I failed to accurately identify the exact font used. If you happen to know what font is used on the book cover, I would appreciate you [letting me know](mailto:hello@patdryburgh.com) :)
|
|
|
|
The theme includes a version of [EB Garamond](https://fonts.google.com/specimen/EB+Garamond), designed by Georg Duffner and Octavio Pardo. It's the closest alternative I could come up with that included an open license to include with the theme.
|
|
|
|
A [copy of the license](https://github.com/patdryburgh/hitchens/blob/master/assets/fonts/OFL.txt) has been included in the `assets` folder and must be included with any distributions of this theme that include the EB Garamond font files.
|
|
|
|
## Contributing & Requesting Features
|
|
|
|
Bug reports, feature requests, and pull requests are welcome on GitHub at https://github.com/patdryburgh/hitchens.
|
|
|
|
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
|
|
## Development
|
|
|
|
To set up your environment to develop this theme, run `bundle install`.
|
|
|
|
The theme is setup just like a normal Jekyll site. To test the theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using the theme. Add pages, documents, data, etc. like normal to test the theme's contents. As you make modifications to the theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
|
|
|
|
## License
|
|
|
|
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
|