Commit b7fda147 authored by Jan-Philipp Stauffert's avatar Jan-Philipp Stauffert
Browse files

Rework Readme

parent 1be4f8e9
# hci-theme
# HCI Theme
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
The HCI Theme packaged as a gem.
## Installation
......@@ -12,13 +8,16 @@ TODO: Delete this and the text above, and describe your gem
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "hci-theme"
gem "hci-theme", :git => "git@gitlab2.informatik.uni-wuerzburg.de:hci-development/hci-theme.git"
gem "jekyll-img-srcset", :git => "git@gitlab2.informatik.uni-wuerzburg.de:hci-development/jekyll-img-srcset.git"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: hci-theme
plugins:
- jekyll-img-srcset
```
And then execute:
......@@ -31,22 +30,34 @@ Or install it yourself as:
## 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](http://contributor-covenant.org) code of conduct.
## Development
To set up your environment to develop this theme, run `bundle install`.
### Menu
The menu is configured in the `_config.yml` file as.
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.
```yaml
menu:
- title: "Home"
href: "/"
items:
- title: "Other"
href: "/other"
```
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 `hci-theme.gemspec` accordingly.
### Image Carousel
The teaser images at the top can be selected for each page individually with a default in the `_config.yml` as:
## License
```yaml
slides:
- general/bbb-demo.jpg
```
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
### Image Resizing
Images get resized to provide lower resulutions for mobile devices. Select which widths to generate in the `_config.yml` with:
```yaml
widths:
- 1688
- 1208
- 844
- 640
- 320
```
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment