New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Continuous Integration for your Jekyll Site (Continued) #2432

Merged
merged 7 commits into from Jun 27, 2014

Conversation

Projects
None yet
5 participants
@parkr
Member

parkr commented May 21, 2014

Ever wondered how to test your Jekyll site? This guide will show you how. Eventually.

  • The test script
  • Travis conf file
  • Enabling Travis鈥揋itHub 馃寛 connection

@parkr parkr referenced this pull request May 21, 2014

Closed

Add a guide for Continuous Integration #2382

0 of 2 tasks complete
@parkr

This comment has been minimized.

Member

parkr commented May 31, 2014

@benbalter Would you be interested in lending a hand here? This page could be super useful for gov folks writing Jekyll sites and interested in stability of their site.

#!/usr/bin/env bash
jekyll build
html-proof ./_site

This comment has been minimized.

@doktorbro

doktorbro Jun 27, 2014

Member

It must be htmlproof ./_site.

@parkr

This comment has been minimized.

Member

parkr commented Jun 27, 2014

@benbalter, @gjtorikian, @penibelst: if you have the time to read this over, I'd love edits/critiques so we can make this a comprehensive guide to continuous integration with Jekyll.

To view it on the site:

$ cd my-jekyll-clone
$ hub checkout https://github.com/jekyll/jekyll/pull/2432
$ bundle install
$ bundle exec rake site:preview
$ open http://localhost:4000/docs/troubleshooting/
Some options can be specified via command-line switches. Check out the
`html-proofer` README for more information about these switches, or run
`html-proof --help` locally.

This comment has been minimized.

@doktorbro

doktorbro Jun 27, 2014

Member

htmlproof --help

When testing Jekyll output, there is no better tool than [html-proofer][2].
This tool checks your resulting site to ensure all links and images exist.
Utilize it either with the convenient `html-proof` command-line executable,

This comment has been minimized.

@doktorbro

doktorbro Jun 27, 2014

Member

htmlproof

incantation here directly:
{% highlight yaml %}
script: jekyll build && html-proof ./_site

This comment has been minimized.

@doktorbro

doktorbro Jun 27, 2014

Member

htmlproof

This comment has been minimized.

@parkr

parkr Jun 27, 2014

Member

Done, thanks!

---
You can easily test your website build against one or more versions of Ruby.
The following guide show how to set up a free build environment on [Travis][0],

This comment has been minimized.

@gjtorikian

gjtorikian Jun 27, 2014

Member

"...guide will show you how..."

@gjtorikian

This comment has been minimized.

Member

gjtorikian commented Jun 27, 2014

parkr added a commit that referenced this pull request Jun 27, 2014

@parkr parkr merged commit 6a7386e into master Jun 27, 2014

1 check was pending

continuous-integration/travis-ci The Travis CI build is in progress
Details

@parkr parkr deleted the docs-4-ci branch Jun 27, 2014

parkr added a commit that referenced this pull request Jun 27, 2014

@ndarville

This comment has been minimized.

Contributor

ndarville commented Jun 27, 2014

Seems like a good guide overall; here is the Travis script for my jekyll-boilerplate project; it doesn鈥檛 fail HTML, (S)CSS, nor JS errors to my recollection, but it covers a bunch of use cases for web developers pretty well.

I鈥檇 consider running bundle exec jekyll build instead of just jekyll build, but that鈥檚 just me being paranoid, mostly.

parkr added a commit that referenced this pull request Jun 27, 2014

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.