We’re eager to work with you, our user community to improve these materials and develop new ones. Please check out our CONTRIBUTING guide for more information on getting started.
This repository currently contains the Git and GitHub Cheatsheets. If you're looking for a project that used to be housed here, such as On-Demand training, reading lists, videos, and book recommendations, see this commit in the repository's history.
- We use Jekyll and Markdown.
- Our content is styled using the Primer CSS toolkit.
If you'd like to have a copy of the files to be served from a web server inside of your firewall, start by running script/package.
- Run
script/packageto create a release tarball. This will be in the formatrelease-XXXXXXX.tgzfor you to take wherever you want. - To test this looks okay, create some folders
mkdir -p test_site/kit. - Untar the release,
tar -xzf release-XXXXXXX.tgz -C test_site/kit. - Switch into the test_site directory,
cd test_site. - View the site with
python -m SimpleHTTPServer. Note: Some servers are obviously more advanced than others and can handle redirects, smart recognition of.htmlfiles, etc
Site content is licensed under CC-BY-4.0. CC-BY-4.0 gives you permission to use the content for almost any purpose but does not grant you any trademark permissions, so long as you note the license and give credit, such as follows:
Content based on github.github.com/training-kit/ used under the CC-BY-4.0 license.
Code used to build and test the site as well as code samples on the site, if any, are licensed under CC0-1.0. CC0 waives all copyright restrictions but does not grant you any trademark permissions.
This means you can use the content and code in this repository except for GitHub trademarks in your own projects.
When you contribute to this repository you are doing so under the above licenses.