Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
The discovery gate for all things educational for Git and GitHub.
Branch: gh-pages
Pull request Compare This branch is 78 commits behind github-archive:gh-pages.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
css
images
js
p
pages
scripts
template
.gitignore
CNAME
Gemfile
Gemfile.lock
NOTES
OUTLINE
README.markdown
Rakefile
apple.png
board.png
book.png
brain.png
episodes.yaml
index.html

README.markdown

Learn.GitHub.com

This is the code and data behind learn.github.com. The page content lives in the pages/ directory and is compiled into the HTML output in p/. Normally, generated files like these wouldn't be checked into source control, but it's required for the GitHub Pages hosting.

If you edit a page, please remember to run 'rake' to recompile the site and create a single commit including both your source and generated files. This makes it as easy as possible for others to work with your changes.

Dependencies, Getting Started

Compiling the site requires maruku, which can be installed with Bundler:

bundle install

Once you've done that, just run rake to compile the site:

rake

Contributing

To contribute to the learn.github site, you can fork the repository, push your changes into it and send a pull request.

If you want to run the site on GitHub pages for testing, you can push your changes into your fork of the repository and it will render at the usual convention of

http://YOURUSERNAME.github.com/THEREPONAME

which, in this case, is:

http://YOURUSERNAME.github.com/learn.github.com

Something went wrong with that request. Please try again.