ndp / git-cheatsheet Goto Github PK

View Code? Open in Web Editor NEW

331.0 21.0 103.0 2.86 MB

Interactive cheatsheet, visualization of git.

Home Page: http://ndpsoftware.com/git-cheatsheet.html

License: MIT License

CSS 1.01% JavaScript 90.69% HTML 8.29%

git-cheatsheet's Introduction

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 test to run the tests
yarn build to transpile.
yarn start to serve
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

License

git-cheatsheet's People

Contributors

Stargazers

Watchers

Forkers

empjustine kierankelleher philipoakley zipkid swapnilmj pabranch moon2l salrjupiter ghorhe jedireturns duncombe sojin protez zodiac1111 gerjanonline acecode landistwo tezcatl nozberkaryaindonesia benjaminherbert beetaa antonio-m rufus125 phdkiran smbrown ro-fdm ravenb porcoesphino diegoag josemalcher dev-bobsong sminutoli ellon evandrokumasaka pixelisart hbcbh1999 adamwrightr01 adamwright01 edouardd67 noscripter xieyunzi rmercadojr py4a velascocode 0017031 ismnoiet kc nku915 phucnguyen81 yafuncl rakibulislam mangon proton6500 ujuc boardkeystown jonqiao michelangelo17 cmon1 jollysolutions tetedacier garthjl1965 matlab-universidad-sinu miltonescobar iambenqazy mtint muratcabuk oblikonline kadvin ttuanhung worthy-os xen0byte r3drock git-going-with-git kjharcombe twirlfog caeu fardman69420 xiaoweish pedrito2 mattbdev lucasll37 zephone onehex falxdraco joeyvee8666 mbelaifa asenar thorehusfeldt skycel9 changsongyang tushar8133 oawad79 js1darren rebornsick ebk13579 adsk-kurtzd vistar fenrikur zerothi sherendas-blessings

git-cheatsheet's Issues

Responsive!

Make the page responsive to different screen sizes

Add "emergency" link

Add link to flow chart to get you out of trouble

http://justinhileman.info/article/git-pretty/git-pretty.png

Site does not work without HTTPS

When you visit the web page with HTTP, the website is not working properly (on Firefox and Chrome).

URL: http://ndpsoftware.com/git-cheatsheet.html

Add ability to show "All" locations at once

This would be useful for printing it out

Localization is broken on last version

Hi @ndp, as you can see, on http://ndpsoftware.com/git-cheatsheet.html#loc=; the localization is broken.
Hitting previous version it seems to be working...

http://ndpsoftware.com/git-cheatsheet/previous/git-cheatsheet.html

cheers!

Show dynamically displayed docs closer to where the element is

More like a "info" click (title attr) that shows up near where the item is.

Great Repo

Great Cheatsheet,
Thanks for sharing !

Fix back button

Hacker News user complained about back button "breaking".

Expected behavior: when hitting back button, changes the view to reflect the URL change.

Bonus: page title changes appropriately.

More keyboard control

How about?

vi keys
short-cuts to different locs
esc to deselect something

`stash save` should be replaced with `stash push`

According the documentation:

This option [git stash save] is deprecated in favor of git stash push.

dockerfile make it simple

FROM node:18-alpine AS base


FROM base AS deps

WORKDIR /app

COPY package.json yarn.lock .yarnrc.yml ./
COPY .yarn ./.yarn

# RUN yarn config set registry 'https://registry.npmmirror.com/' && yarn install
RUN yarn config set npmRegistryServer  'https://registry.npmmirror.com/' && yarn install



FROM base AS builder

WORKDIR /app

COPY . .
COPY --from=deps /app /app

RUN pwd && ls -al &&  yarn build




FROM base AS runner

WORKDIR /app

COPY --from=builder /app/* ./

EXPOSE 8080

CMD ["yarn", "start"]

git pull missing information

git pull not only updates your workspace but also adds a merge commit to your local repository. This could be confusing for some users.

I'm not sure how you would present this given the formatting though.

Great visualization btw!

Arrows for some commands should not touch "Upstream repository"

Hi @ndp ! I really like this cheat sheet! It really helped me when I was starting out with Git.

I noticed that the arrow for a few commands end or begin in the "Upstream repository", but they in fact do not communicate with the upstream repository:

reset --hard <remote>/<branch> : this reset the current branch to the commit at the tip of the remote-tracking branch <remote>/<branch>. The <remote> remote is not fetched. As such, I think this arrow should start in the "Local repository".
branch --track new <remote>/<branch> same thing; this does not communicate with the upstream repository so it should both start and end in the "Local repository".
branch -r : this lists remote-tracking branches, and does not communicate with the "Upstream repository". It should be in "Local repository".

My point of view is that only commands that talk to the "Upstream repository" should have their arrows touching it. I think it's important for begginers to clearly distinguish between Git commands that are local and Git commands that talk to remote repositories.

Would you accept a PR that would make these changes ?

Adding RTL mode for supporting RTL languages.

Is your feature request related to a problem? Please describe.
Hi! I want to contribute to this project and Persian language, but as it's a RTL language, forcing it to be shown LTR is not a good idea.

Describe the solution you'd like
Adding a RTL mode for RTL languages.

Describe alternatives you've considered
I don't know what to write here. :/

Additional context

Here, I added direction: rtl; for testing the layout.

Translate to Brazilian Portuguese (pt-br)

It would be awesome to see a translation to pt-br just like the other ones (fr, de, etc.).

I can take this task, as soon as I receive some starting guidelines.

I've noticed a JSON file with translation. Would that be enough?

ndp / git-cheatsheet Goto Github PK

git-cheatsheet's Introduction

Git Cheatsheet

Contributors

To add a translation

Development

Deploy

FAQ

Are there any "features"?

Why is it called "Cheat Sheet"?

Like it or have ideas?

License

git-cheatsheet's People

Contributors

Stargazers

Watchers

Forkers

git-cheatsheet's Issues

Recommend Projects

Recommend Topics

Recommend Org