Skip to content

kmutahar/jekyll-theme-dscliu

Repository files navigation

jekyll-theme-dscliu

All Contributors

Contributor Covenant Gem Version

Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in _layouts, your includes in _includes, your sass files in _sass and any other assets in assets.

To experiment with this code, add some sample content and run bundle exec jekyll serve – this directory is setup just like a Jekyll site!

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-dscliu"

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

theme: jekyll-theme-dscliu

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-dscliu

Usage

TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant 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-dscliu.gemspec accordingly.

License

The theme is licensed under the terms of the GNU Affero General Public License v3.0 only.

jekyll-theme-dscliu: A Jekyll theme that is used by the DSC LIU Yemen Chapter
Copyright (C) 2020  "Khaldoon Mutahar", "DSC LIU Yemen"

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Khaldoon Mutahar

💼 🚇 🚧 💻

Safa Moqbel

💼 💻 🎨

mohammed0alhaddad

💻 🐛

ShEhAb0

💻

This project follows the all-contributors specification. Contributions of any kind welcome!