Git Cheatsheet

Standalone HTML page that organizes Git's commands by what they affect. Built as I was learning git and trying to understand it. It's proved useful to others in the same endeavor.

Contributors

Development by Andrew Peterson, NDP Software
French translation by Bernard Opic
Simplified Chinese translation by acecode
Improve Simplified Chinese translation by rebornsick
Traditional Chinese translation by Hsins
Bug fix by GerjanOnline
Spanish translation by sminutoli
Korean translation by ujuc
Italian translation by antoniopantaleo
Vietnamese translation by trgiangdo
Portuguese translation by HenriqueAJNB
Russian translation by vistar

Comments and pull requests welcome.

To add a translation

Determine the 2-letter language code (ISO 639-1). See the existing files in git-cheatsheet/lang.
Create a new JSON file with the name of the code in git-cheatsheet/lang. Choose one of the other languages as a starting point.
Write your translation. Use the exact identical property keys in the JSON structure. Only change the values.
Add a link for users to choose the translation. In git-cheatsheet.html, insert (alphabetically) a new line that looks like:

<a class="lang" data-lang="vi" data-docs="Vietnamese translation by trgiangdo">vn</a>

Add your name to the README.md above.
Test manually
Create a pull request. Give me a couple days to reply, but then feel free to write.
Once it's merged, tell people about it.

Keep the PR restricted to changes related to the translation.

Development

Files are in the src folder. To see it locally:

yarn install to install dependencies
yarn test to run the tests
yarn build to transpile.
yarn start or yarn start-docker to serve. The latter uses a Docker container.
Open http://127.0.0.1:8080/git-cheatsheet.html to view the page

CI is on Github Actions.

Deploy

Use FTP to upload to NDP Software

Exceptions caught and logged on Rollbar (private).

FAQ

Are there any "features"?

You can navigate over different "locations" and commands with the mouse, arrow keys, or vi-like keystrokes.

Why is it called "Cheat Sheet"?

It's pretty silly, actually. I had a little SEO juice from a couple other real cheat sheets, so I thought I'd just leverage that term. In retrospect, I think this was an okay tactic, as it brought people to the page.

Like it or have ideas?

If you like this and would like me to do more intereactions like this, send me an email... or patreon.com/ndp

ndp/git-cheatsheet