veryroundbird.house / homemadejam
templates for self-hosting game jams (or any other kind of jam tbh)
fork atom
homemadejam / jekyll / README.md
at c225a623f242ecce2f3dea6dd4db73739e747eb4 2.1 kB view raw view rendered
1# Jekyll Theme Quickstart 2> Scaffold for a basic Jekyll theme for use as a reference or template 3 4[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/jekyll-theme-quickstart)](https://github.com/MichaelCurrin/jekyll-theme-quickstart/tags/?include_prereleases&sort=semver) 5[![License](https://img.shields.io/badge/License-MIT-blue)](#license) 6 7[![Ruby](https://img.shields.io/badge/Ruby->=2.3-blue?logo=ruby&logoColor=white)](https://ruby-lang.org) 8[![Jekyll](https://img.shields.io/badge/Jekyll-3.9-blue?logo=jekyll&logoColor=white)](https://jekyllrb.com) 9 10 11## How to use this project 12 13### Quickstart 14 15Create a new project from this template. Or just use the code or docs here as a reference. 16 17<div align="center"> 18 19[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge&logo=github)](https://github.com/MichaelCurrin/jekyll-theme-quickstart/generate) 20 21</div> 22 23### Demo 24 25View a live demo on GH Pages: 26 27<div align="center"> 28 29[![View demo](https://img.shields.io/badge/View-Demo_site-blue?style=for-the-badge)](https://michaelcurrin.github.io/jekyll-theme-quickstart/) 30 31</div> 32 33The demo site's code is on this repo's own [gh-pages](https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages) branch and uses the Remote Theme plugin approach to load the theme from the main branch of this project. 34 35 36## Documentation 37 38[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue)](/docs/) 39 40 41## Contributing 42 43Bug reports and pull requests are welcome on GitHub at [github.com/MichaelCurrin/jekyll-theme-quickstart](https://github.com/MichaelCurrin/jekyll-theme-quickstart). 44 45This 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. 46 47 48## License 49 50Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin). 51 52The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).