This is a starter project for people making Jekyll sites for hosting in Github Pages and editing with Prose.io.
- Clearly documented
- Ready for Prose.io (includes a links.json, edit link on each page, and various _config settings)
- Uses Bootstrap 3
- Uses Redcarpet, the same markdown renderer as Github. TODO: Document GFM features in demo page.
- Fork me.
- Rename the fork to YOURNAME.github.io in project settings to enable Github Pages.
- Wait 10 minutes for the site to show up.
- Edit your site using Prose or Github. Start with _config.yml and index.html.
Github Pages caches pages for 10 minutes whenever they are accessed. If you make a change while the page is cached, you will still see the old page until the cached page expires.
To bypass the cache, add a "cache-busting" query string after the URL, like so:
`http://mysite.github.io/my-page?somerandomstring`.
If you have an error in one of your pages or templates, the new version will fail to build and Github will send you an email lacking any detail about what caused the failure.
To see the error you can run Jekyll locally on a workstation.
Front Github pages with a free Cloudflare account, as detailed in this article.
Warning: You might end up with merge conflicts once you've customized your site, which you'll have to resolve manually.
You can merge my changes into your branch.
Here are the basic steps, using a local checkout of your repo:
-
Add me as a remote:
git remote add reusable [email protected]:edrex/reusable-jekyll-site.git git fetch reusable -
Merge, resolving conflicts as needed:
git merge reusable/master master
Alternatively, if you know which commits contain the features you want, you might want to cherry-pick just those commits.