|
| 1 | +# _Airspace_ for Jekyll |
| 2 | + |
| 3 | + |
| 4 | +This Jekyll theme is a port of [ThemeFisher's ](https://themefisher.com) [Airspace template ](https://themefisher.com/products/airspace-free-bootstrap-website-template/). It is released under ThemeFisher's [license ](https://themefisher.com/license) , which requires attribution. Concern about the licnese please contact with [them ](mailto:[email protected]) |
| 5 | + |
| 6 | +## Usage |
| 7 | +To start your project, [fork this respository](https://github.com/ndrewtl/airspace-jekyll/fork), put in your content, and go! |
| 8 | + |
| 9 | +## Examples |
| 10 | +Here are some projects that have used this Jekyll Theme: |
| 11 | +* [BOYUAN Open Source 博辕开源](https://boyuanitsm.github.io) |
| 12 | +* [Campus VC](https://mrchildneo.github.io/mrchildneo/) |
| 13 | +* [Mãos de amar](https://www.maosdeamar.com.br/) |
| 14 | +* [ATK Team](http://www.atksec.com/) |
| 15 | +* [Coding Club](https://ourcodingclub.github.io/) |
| 16 | +* [Dev Empathy Book Club](http://www.devempathybook.club/) |
| 17 | +* [DKAN Open Data Catalog](http://getdkan.com) (modified version of this theme) |
| 18 | + |
| 19 | +## Steps for Setup: |
| 20 | + |
| 21 | +### Make sure you have Ruby |
| 22 | + |
| 23 | +First, make sure you have [Ruby](https://www.ruby-lang.org/en/) installed. You can confirm this by running `ruby -v` on the command line: |
| 24 | + |
| 25 | +```sh |
| 26 | +$ ruby -v |
| 27 | +ruby [version number] (date) [your platform] |
| 28 | +``` |
| 29 | + |
| 30 | +If you get something like `"Error, command not found"` visit the link above and |
| 31 | +install Ruby for your platform. |
| 32 | + |
| 33 | + |
| 34 | +### Make sure you have Bundler |
| 35 | + |
| 36 | +Next, make sure you have [Bundler](https://bundler.io) installed. Just like |
| 37 | +above, run `bundle -v` on the command line: |
| 38 | + |
| 39 | +```sh |
| 40 | +$ bundle -v |
| 41 | +bundle [version number] |
| 42 | +``` |
| 43 | + |
| 44 | +If you get `"Error, command not found"` run `gem install bundler` to install it |
| 45 | +using RubyGems. |
| 46 | + |
| 47 | +### Run this repository |
| 48 | + |
| 49 | +Clone the repository, and `cd` into it: |
| 50 | +```sh |
| 51 | +$ git clone https://github.com/ndrewtl/airspace-jekyll.git |
| 52 | +$ cd airspace-jekyll |
| 53 | +``` |
| 54 | + |
| 55 | +Install dependencies locally: |
| 56 | +```sh |
| 57 | +$ bundle install --path vendor/bundle |
| 58 | +``` |
| 59 | + |
| 60 | +This should install a local copy of jekyll. |
| 61 | + |
| 62 | +Now run the server: |
| 63 | +```sh |
| 64 | +$ ./vendor/bundle/ruby/#{YOUR_RUBY_VERSION}/bin/jekyll server |
| 65 | +``` |
0 commit comments