https://github.com/dankimio/jekyll-theme-gatsby

Jekyll port of gatsby-starter-blog theme.
https://github.com/dankimio/jekyll-theme-gatsby

gatsby jekyll jekyll-theme jekyll-themes

Last synced: about 1 month ago
JSON representation

Jekyll port of gatsby-starter-blog theme.

• Host: GitHub
• URL: https://github.com/dankimio/jekyll-theme-gatsby
• Owner: dankimio
• License: mit
• Created: 2020-11-26T19:36:13.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-07-09T14:20:13.000Z (over 2 years ago)
• Last Synced: 2024-10-11T19:40:48.100Z (3 months ago)
• Topics: gatsby, jekyll, jekyll-theme, jekyll-themes
• Language: CSS
• Homepage:
• Size: 770 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# jekyll-theme-gatsby

![Screenshot](screenshot.png)

Jekyll port of [gatsby-starter-blog](https://github.com/gatsbyjs/gatsby-starter-blog)'s theme.

## Installation

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

```ruby

gem "jekyll-theme-gatsby"

```

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

```yaml

theme: jekyll-theme-gatsby

```

And then execute:

    $ bundle

## Usage

Provide the following configuration in your `_config.yml`:

```yaml

author:

  name: "Your awesome title"

  summary: "Write an awesome description for your new site here. You can edit this

  line in _config.yml."

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dankimio/jekyll-theme-gatsby. 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`, `_sass` and `assets` tracked with Git will be bundled.

To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-gatsby.gemspec` accordingly.

## License

The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).