The gh-pages
branch for Futel.net is a Jekyll site hosted on GitHub Pages. As such, much of the documentaiton there will be helpful towards managing this site, but in particular this one: Using Jekyll as a static site generator with GitHub Pages.
- Requirements
- Running the site locally and previewing changes
- Previewing changes
- Making commits
- ubuntu or debian box
- apt install make gcc g++ ruby ruby-dev ruby-rubygems
- gem install jekyll bundler jekyll-feed jekyll-gist jekyll-paginate
More information at http://jekyllrb.com/docs/installation/ubuntu/
Documentation for the options running a Jekyll site locally can be found on the Jekyll basic usage page, but here is a quickstart guide for running this site locally and previewing your changes:
- Change into the root directory for this project in the terminal.
- Run
jekyll s --watch
- Open
http://localhost:4000
in your browser to preview the site - As you make changes the site should rebuild itself automatically.
To make a change to the site
- Fork the repo: https://github.com/futel/futel.net
- Checkout the
gh-pages
branch - Start Jekyll per the previous section to preview your changes in real-time and make your changes
- When you're done with your changes create the commit and push it to your forked repo on GitHub
- Go to the Pull Requests tab in your forked project click the New pull request button. Make sure that you're creating a pull request from your
gh-pages
branch and requesting to merge it into futel.net'sgh-pages
branch. - GitHub should tell you if it's possible to auto-merge. When it's done click Create pull request to submit your proposed changes.
- After review and approval your changes will be merged.