forked from data.coop/website
91 lines
3.5 KiB
Markdown
91 lines
3.5 KiB
Markdown
|
# minima
|
||
|
|
|
||
|
|
*Minima is a one-size-fits-all Jekyll theme for writers*. It's Jekyll's default (and first) theme. It's what you get when you run `jekyll new`.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Add this line to your Jekyll site's Gemfile:
|
||
|
|
|
||
|
|
```ruby
|
||
|
|
gem "minima"
|
||
|
|
```
|
||
|
|
|
||
|
|
And add this line to your Jekyll site:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
theme: minima
|
||
|
|
```
|
||
|
|
|
||
|
|
And then execute:
|
||
|
|
|
||
|
|
$ bundle
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
### Customization
|
||
|
|
|
||
|
|
To override the default structure and style of minima, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file.
|
||
|
|
e.g., to override the [`_includes/head.html `](_includes/head.html) file to specify a custom style path, create an `_includes` directory, copy `_includes/head.html` from minima gem folder to `<yoursite>/_includes` and start editing that file.
|
||
|
|
|
||
|
|
The site's default CSS has now moved to a new place within the gem itself, [`assets/main.scss`](assets/main.scss). To **override the default CSS**, the file has to exist at your site source. Do either of the following:
|
||
|
|
- Create a new instance of `main.scss` at site source.
|
||
|
|
- Create a new file `main.scss` at `<your-site>/assets/`
|
||
|
|
- Add the frontmatter dashes, and
|
||
|
|
- Add `@import "minima";`, to `<your-site>/assets/main.scss`
|
||
|
|
- Add your custom CSS.
|
||
|
|
- Download the file from this repo
|
||
|
|
- Create a new file `main.scss` at `<your-site>/assets/`
|
||
|
|
- Copy the contents at [assets/main.scss](assets/main.scss) onto the `main.scss` you just created, and edit away!
|
||
|
|
- Copy directly from Minima 2.0 gem
|
||
|
|
- Go to your local minima gem installation directory ( run `bundle show minima` to get the path to it ).
|
||
|
|
- Copy the `assets/` folder from there into the root of `<your-site>`
|
||
|
|
- Change whatever values you want, inside `<your-site>/assets/main.scss`
|
||
|
|
|
||
|
|
--
|
||
|
|
|
||
|
|
### Enabling comments (via Disqus)
|
||
|
|
|
||
|
|
Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.
|
||
|
|
|
||
|
|
To enable it, add the following lines to your Jekyll site:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
disqus:
|
||
|
|
shortname: my_disqus_shortname
|
||
|
|
```
|
||
|
|
|
||
|
|
You can find out more about Disqus' shortnames [here](https://help.disqus.com/customer/portal/articles/466208).
|
||
|
|
|
||
|
|
Comments are enabled by default and will only appear in production, i.e., `JEKYLL_ENV=production`
|
||
|
|
|
||
|
|
If you don't want to display comments for a particular post you can disable them by adding `comments: false` to that post's YAML Front Matter.
|
||
|
|
|
||
|
|
--
|
||
|
|
|
||
|
|
### Enabling Google Analytics
|
||
|
|
|
||
|
|
To enable Google Anaytics, add the following lines to your Jekyll site:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
google_analytics: UA-NNNNNNNN-N
|
||
|
|
```
|
||
|
|
|
||
|
|
Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Bug reports and pull requests are welcome on GitHub at https://github.com/jekyll/minima. 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`.
|
||
|
|
|
||
|
|
To test your theme, run `bundle exec rake preview` and open your browser at `http://localhost:4000/minima/`. This starts a Jekyll server using your theme and the contents of the `example/` directory. As you make modifications to your theme and to the example site, your site will regenerate and you should see the changes in the browser after a refresh.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|