https://github.com/zddhub/gravid
A simple and beautiful Jekyll theme.
https://github.com/zddhub/gravid
gravid jekyll-site jekyll-theme
Last synced: 11 months ago
JSON representation
A simple and beautiful Jekyll theme.
- Host: GitHub
- URL: https://github.com/zddhub/gravid
- Owner: zddhub
- License: mit
- Created: 2017-06-08T23:56:46.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-17T03:04:59.000Z (over 1 year ago)
- Last Synced: 2025-05-28T08:52:25.997Z (about 1 year ago)
- Topics: gravid, jekyll-site, jekyll-theme
- Language: SCSS
- Homepage: https://zddhub.github.io
- Size: 1.33 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# gravid
Welcome to your new Jekyll theme - gravid!
Being talented just like being gravid, must be known with a long time past. I think I need more time to be talented, so I choose an easy one and named 'gravid'. 😊
[Theme preview](https://zddhub.github.io)
## Usage
Create a new Jekyll site:
```sh
jekyll new your-blog-name
```
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "gravid"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: gravid
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install gravid
Copy default files to your site:
```sh
cp -r $(bundle show gravid)/*.{md,html,yml} .
```
Run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
## Development
Gravid has been scaffolded by the `jekyll new-theme` command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration.
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.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/zddhub/gravid. 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.
## Thanks
Inspiration from [Sofish's personal blog](https://github.com/sofish/sofi.sh), Thanks.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
### Contact
If you have any question, please [email to me](mailto:zddhub@gmail.com).