https://github.com/wheelerlaw/ultimate-ghpages-jekyll-template
The ultimate Jekyll template for use with Github pages and TravisCI
https://github.com/wheelerlaw/ultimate-ghpages-jekyll-template
gh-pages jekyll
Last synced: 2 months ago
JSON representation
The ultimate Jekyll template for use with Github pages and TravisCI
- Host: GitHub
- URL: https://github.com/wheelerlaw/ultimate-ghpages-jekyll-template
- Owner: wheelerlaw
- License: mit
- Created: 2018-06-22T20:31:33.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2018-06-22T21:19:43.000Z (almost 7 years ago)
- Last Synced: 2025-01-30T07:31:00.964Z (4 months ago)
- Topics: gh-pages, jekyll
- Language: Ruby
- Size: 107 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ultimate-ghpages-jekyll-template
[](https://travis-ci.com/wheelerlaw/ultimate-ghpages-jekyll-template)
### The ultimate Jekyll template for use with Github pages and TravisCI
## Getting Started
To use this template, first fork this repo.
Then configure the default branch to be `develop` (if you haven't already done so):
Next, configure the repo settings to use Github pages like so:
Currently this template only supports setting the `master` branch as the Github Pages source.
Next, navigate to the page for the repo (in this repo's case, [wheelerlaw.github.io/ultimate-ghpages-jekyll-template](http://wheelerlaw.github.io/ultimate-ghpages-jekyll-template)):
## Build System
This template comes with a pre-configured `.travis.yml` ready for easy continuous deployment of your website. All you need to do is add your Github API token to the `env` section of the repo's `.travis.yml` with the following command:
travis encrypt --pro GITHUB_TOKEN= --add env
## Using The Template Locally
Installing depdencies:
```sh
sudo apt-get install ruby-dev
sudo gem install jekyll jekyll-paginate rake
```
Build the site:
```sh
jekyll build
```
You can alternatively use jekyll to serve the site locally without having to push it to GitHub:
```sh
jekyll serve
```
## Contributing To Your Website
This template uses a simple multi-branch deployment model to separate the deployed code on the `master` branch from the trunk development branch, `develop`.
Notable branches:
- `develop`: This is the "master" branch of the repo, if you will. When you are starting a new feature, branch from here. This is also the branch against which you will create pull requests. Furthermore, Travis listens for changes on this branch to deploy to `master`.
- `master`: The contents of this branch are served to the public by GitHub pages and are built automatically by Travis when a pull request to `develop` is merged. **Do not touch this branch for any reason.**
Before you clone the repository, there are some settings you should set:
```
git config --global push.default current
git config --global user.name ""
git config --global user.email "