Atlas48/funky
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add installation instructions to demo site

Browse Source
This commit is contained in:
David Darnes 2018-01-01 21:48:27 +00:00
parent 4ddca4d521
commit afc44412a3
1 changed files with 25 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
about.md
View File

@ -10,21 +10,30 @@ A stupidly simple theme for Jekyll, using the official Jekyll theme implementati
## Installation ## Installation
### As a Fork ### As a Jekyll theme
1. Add `gem "garth-jekyll-theme"` to your `Gemfile` to add the theme as a dependancy
2. Run the command `bundle install` in the root of project to install the theme and its dependancies
3. Add `theme: garth-jekyll-theme` to your `_config.yml` file to set the site theme
4. Run `bundle exec jekyll serve` to build and serve your site
5. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options
### As a GitHub Pages remote theme
1. Add `gem "jekyll-remote-theme"` to your `Gemfile` to add the theme as a dependancy
2. Run the command `bundle install` in the root of project to install the jekyll remote theme gem as a dependancy
3. Add `jekyll-remote-theme` to the list of `plugins` in your `_config.yml` file
4. Add `remote_theme: daviddarnes/garth` to your `_config.yml` file to set the site theme
5. Run `bundle exec jekyll serve` to build and serve your site
6. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options
### As a Boilerplate / Fork
_(deprecated, not recommended)_
1. [Fork the repo](https://github.com/daviddarnes/garth#fork-destination-box) 1. [Fork the repo](https://github.com/daviddarnes/garth#fork-destination-box)
2. Clone down the repo with `$ git clone git@github.com:username/reponame.git` 2. Replace the `Gemfile` with one stating all the gems used in your project
3. Delete the `demo/` folder and `screenshot.png` files 3. Delete the following unnecessary files/folders: `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE`, `screenshot.png`, `CNAME` and `garth-jekyll-theme.gemspec`
4. Change the `CNAME` record to your projects' record 4. Run the command `bundle install` in the root of project to install the jekyll remote theme gem as a dependancy
5. Install bundler with `$ gem install bundler` 5. Run `bundle exec jekyll serve` to build and serve your site
6. Install gems with `$ bundle install` 6. Done! Use the example [`_config.yml`](https://github.com/daviddarnes/garth/blob/master/_config.yml) file to set site-wide options
7. Run Jekyll with `$ bundle exec jekyll serve --watch`
8. Begin hacking for your project
### As a Jekyll 3.3 theme gem
1. Download the starter `/demo` content, [quick download link](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/daviddarnes/garth/tree/master/demo)
2. Install bundler with `$ gem install bundler`
3. Install gems with `$ bundle install`
4. Run Jekyll with `$ bundle exec jekyll serve --watch`
5. Begin hacking for your project