Github

View README.md localhost #

pip install grip # https://github.com/joeyespo/grip
cd myrepo
grip # Running on http://localhost:6419/

Update: grip support with limited times of usage, we can use VSCode markdown previwer instead.

Clone via [email protected] (ssh) #

👉 More references: this and this.

# Windows + Linux
ssh-keygen -t rsa -b 4096 -C "[email protected]"
# (-C for adding comment only)
# Enter a file:
# Linux: /home/thi/.ssh/id_rsa
# Windows: C:\Users\dinha\.ssh\id_rsa
# Enter password

# NOTE: if you use different emails, create diffre id_rsa files (with different names)

# Tell who you are? (it's global, you may need to set it locally for each repo)
git config --global user.name "Thi Dinh"
git config --global user.email [email protected]

# ~/.ssh/config
# Default github account: [email protected]
Host github.com
   HostName github.com
   IdentityFile ~/.ssh/id_rsa
   IdentitiesOnly yes

# Other github account: [email protected]
Host github.com
   HostName github.com
   IdentityFile ~/.ssh/id_rsa_ideta
   IdentitiesOnly yes

# Linux only
# Be careful, it will reset and use different agent!!!!
# Use "ssh-add -l" to check first!
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_rsa

# delete all cached keys (be careful)
ssh-add -D

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_rsa
# ssh-add ~/.ssh/id_rsa_ideta

# check saved keys
ssh-add -l

# Try to reset ssh agent
eval "$(ssh-agent -s)"
# and add again all the profiles you have

# Go to https://github.com/settings/keys
# copy public key
cat ~/.ssh/id_rsa.pub

# clone some repo
git clone [email protected]:dinhanhthi/dinhanhthi.com.git

# You may have to set the specific config user name and email on the repo
# (without -g)
git config user.name "Thi"
git config user.name "[email protected]"

Info #

• Commits to a fork don't appear in your contributions graph.
• Commits to a generated from template can appear in your contributions graph.

Repo template #

I wanna make a theme notetheme2 based on dinhanhthi.com.

1. Make dinhanhthi.com be a template (Go to Settings)

2. Create a new repo based on this template.

3. Create a new branch notetheme2 on dinhanhthi.com. Make changes on this branch.

4. Everything we have a "theme change" on dinhanhthi.com/master, merge it to branch dinhanhthi.com/notetheme2.

5. If there are files (only for files) in dinhanhthi.com/notetheme2 you wanna keep, add below line to .gitattributes (under branch dinhanhthi.com/notetheme2) before performing the merge,

   # add line to .gitattributes
   echo 'file_name.txt merge=ours' >> .gitattributes
   # on windows, remove `''`

6. If there are folders (or files) in dinhanhthi.com/notetheme2 you don't wanna keep (from /master), just delete them and make a new commit. From this time, later merges will ignore them.

7. If there are folders in /notethem2 you wanna keep the current state (instead of merging from master), create a script reset_folders.sh

   #!/bin/sh
   # used for branch notetheme2 only
   echo 'Reset some only-this-branch folders after merging.'
   git reset folder_1 folder_2
   git checkout .
   git add .
   git commit -m "update from master"

   Each time you run the merge, run

   git merge master && sh reset_folders.sh

8. Update changes from dinhanhthi.com/notetheme2 to repo notetheme2^[ref].

   # add dinhanhthi.com as a remote
   git remote add template [URL of the template repo]

   # update the changes
   git fetch --all

   # update from template's branch
   git merge template/notetheme2

9. If there is an error fatal: refusing to merge unrelated histories, try to add --allow-unrelated-histories. There must be conflict.

   # keep remotes
   git merge -X theirs template/notetheme2 --allow-unrelated-histories
   # keep local
   git merge -X ours template/notetheme2 --allow-unrelated-histories

Add Shields tags #

👉 Main shield site here.
👉 Example of usage: my main github page.

# scikit-learn badge
http://img.shields.io/badge/-Scikit%20Learn-efa300?style=flat-square&logo=scikit-learn&logoColor=fff
# ...<NAME>-<Background-Color>?style...&logo=<LOGO>&logoColor=<LOGO-COLOR>

• Logo name can be found at simpleicon. If the name includes spaces, replace them with dashes (e.g: ?logo=visual-studio-code)
• Wanna create a custom logo?
  • Change SVG to PNG if needed: use this site.
  • Change logo's color to white: use this site.
  • Must resize the image to 14x14: use this site.
  • Convert to base64 file: use this site, then copy data:image/png;base64,iVB... and paste after &logo=

Errors #

fatal: Authentication failed for: It's because you enabled two-factor authentication in your Github account.

1. Generate a new token: click here.
2. Copy that token and use it as a new password.

ssh: connect to host github.com port 22: No route to host
fatal: Could not read from remote repository

# solution
nano ~/.ssh/config
# add following
Host github.com
    Hostname ssh.github.com
    Port 443
# run again to check
ssh -T [email protected]