Skip to content

Commit

Permalink
Updated README with deployment instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasvaeth committed Oct 30, 2018
1 parent 8813d82 commit e4b0f1c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
4 changes: 0 additions & 4 deletions Gemfile
Expand Up @@ -10,10 +10,6 @@ source "https://rubygems.org"
# Happy Jekylling!
gem "jekyll", "~> 3.6.2"

# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins

# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-paginate"
Expand Down
7 changes: 7 additions & 0 deletions README.md
Expand Up @@ -16,6 +16,7 @@ Barber is a minimal blog theme built for Jekyll. The blog theme features a mason
* [Disqus Comments](#disqus-comments)

## Additional Development
* [Deployment](#deployment)
* [Source Code](#source-code)
* [Donations](#donations)
* [Support](#support)
Expand Down Expand Up @@ -126,6 +127,12 @@ Comments can be enabled on every blog post in a few steps steps. The first step

***

### Deployment
GitHub Pages [does not support]((https://help.github.com/articles/adding-jekyll-plugins-to-a-github-pages-site/)) custom plugins. The tag list and tag pagination are built using custom plugins. There are several options to avoid any errors while deploying to production.
* Run ````bundle exec jekyll build```` or ````npm run build```` and manually add the contents of the ```_site``` folder to the ```gh-pages``` branch.
* Link the repository to [Netlify](https://www.netlify.com/). Netlify will then rebuild the theme every time a commit is pushed to the repo.
* Finish setting up the [s3-website](https://github.com/klaemo/s3-website) package that is already included in the theme. This would deploy the theme to AWS S3 when ```npm run deploy``` is run.

### Source Code
The source code is broken down to make finding what you need as easy as possible. Almost everything runs through ````gulpfile.js````, so you will need to run ````npm install```` on your command line before doing any additional development. You can then run ````gulp```` or ````npm run gulp```` to compile everything.

Expand Down

0 comments on commit e4b0f1c

Please sign in to comment.