https://github.com/elliotpenson/composure

A simple Jekyll theme inspired by Telegraph.
https://github.com/elliotpenson/composure

jekyll-theme

Last synced: about 2 months ago
JSON representation

A simple Jekyll theme inspired by Telegraph.

• Host: GitHub
• URL: https://github.com/elliotpenson/composure
• Owner: ElliotPenson
• License: mit
• Created: 2017-03-11T04:47:02.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-11T06:14:51.000Z (almost 8 years ago)
• Last Synced: 2024-04-26T10:20:47.492Z (8 months ago)
• Topics: jekyll-theme
• Language: HTML
• Homepage: https://rubygems.org/gems/composure
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# composure

A simple Jekyll theme inspired by [Telegraph](telegra.ph).

## Installation

Add this line to your Jekyll site's `Gemfile`:

```ruby

gem "composure"

```

And add this line to your Jekyll site's `_config.yml`:

```yaml

theme: composure

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install composure

## Usage

TODO: Write usage instructions here. Describe your available layouts, includes,

and/or sass.

## Contributing

Bug reports and pull requests are welcome on GitHub at

https://github.com/ElliotPenson/composure. 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`.

Your theme is setup just like a normal Jekyll site! To test your theme, run

`bundle exec jekyll serve` and open your browser at `http://localhost:4000`.

This starts a Jekyll server using your theme. Add pages, documents, data, etc.

like normal to test your theme's contents. As you make modifications to your

theme and to your content, your site will regenerate and you should see the

changes in the browser after a refresh, just like normal.

When your theme is released, only the files in `_layouts`, `_includes`, and

`_sass` tracked with Git will be released.

Create a new gem for composure with `gem build composure.gemspec`. Install this

gem locally with `gem install ./composure-VERSION.gem`. Share the gem on

rubygems.org with `gem push composure-VERSION.gem`.

## License

The theme is available as open source under the terms of the 

[MIT License](https://opensource.org/licenses/MIT).