git.piffa.net Git - aerei_site/blob - README.md

   1 # Jekyll Cayman theme
   2
   3 This is a [Jekyll][1] theme for [@jasonlong][2]'s [Cayman theme][4] on [GitHub Pages][3].
   4
   5 Cayman is a clean, responsive theme for [GitHub Pages](https://pages.github.com). This theme is available as an option if you use the [Automatic Page Generator](https://help.github.com/articles/creating-pages-with-the-automatic-generator/) or you can copy the template and styles to use on your own.
   6
   7 You can preview the theme at http://jasonlong.github.io/cayman-theme or with real content at http://jasonlong.github.io/geo_pattern.
   8
   9 ![](http://cl.ly/image/1T3r3d18311V/content)
  10
  11 # How to use it?
  12
  13 Download the theme @ http://github.com/pietromenna/jekyll-cayman-theme/archive/master.zip
  14
  15 Unzip it and use it as a regular jekyll folder.
  16
  17 ```
  18 $ unzip jekyll-cayman-theme-master.zip
  19 ```
  20
  21 Get inside the newly extracted folder
  22 ```
  23 $ cd jekyll-cayman-theme-master
  24 ```
  25
  26 Get the required gems
  27 ```
  28 $ bundle install
  29 ```
  30
  31 Use it!
  32
  33 ```
  34 $ jekyll serve
  35 ```
  36
  37 For more details read about [Jekyll][1] on its web page.
  38
  39 # Setup
  40
  41 Some important configuration can be done in the file `_config.yml`. Please, check the Setup section in that file.
  42
  43
  44 ## baseurl
  45
  46 `baseurl` parameter is required in the case the site doesn't sit on the root of the domain. For example: http://pietromenna.github.io/jekyll-cayman-theme
  47
  48 In the case above the baseurl should be set to "/jekyll-cayman-theme".
  49
  50 In the case the site sits in the root, you can leave `baseurl` as empty "".
  51
  52 # Contributing
  53
  54 Bug reports and pull requests are welcome on GitHub at https://github.com/pietromenn/jekyll-cayman-theme.
  55
  56 # Development
  57
  58 To set up your environment to develop this theme, run `bundle install`.
  59
  60 You theme is setup just like a normal Jelyll 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.
  61
  62 # License
  63
  64 This work is licensed under a [Creative Commons Attribution 4.0 International](http://creativecommons.org/licenses/by/4.0/) license.
  65
  66 [1]: http://jekyllrb.com/
  67 [2]: https://github.com/jasonlong
  68 [3]: http://pages.github.com/
  69 [4]: https://github.com/jasonlong/cayman-theme