/gh-profile-cheatsheet

sunglasses A condensed Doc for awesome GitHub Profile READMEs memo

Cheatsheet for Github profiles README.md

Disclaimer: Notice this is Work in Progress and might contain errors!

What you can Integrate:

  • Markdown
  • Badges
  • Collapsible Content
  • Html(limited)
  • Images
  • SVG
  • Gifs
  • Define Terminal Cmds
  • Preview sytax highlighted Code
  • Latex

Rescources

Contents

Collapse

How to

<details>
  <summary>Click me</summary>
  
  ### Heading
  1. Foo
  2. Bar
     * Baz
     * Qux

  ### Some Code
  ```js
  function logSomething(something) {
    console.log('Something', something);
  }
  ```
</details>

Example

Click me

Heading

  1. Foo
  2. Bar
    • Baz
    • Qux

Some Code

function logSomething(something) {
  console.log('Something', something);
}

Rules

  1. Have an empty line after the </summary> tag or markdown/code blocks will not render.
  2. Have an empty line after each </details> tag if you have multiple collapsible sections.

Author

Links

Via MarkDown

[Description](URL/Link)

e.g.

[Youtube](https://youtube.com\) rendered: Youtube

Via HTML Youtube

Html

tags that work

<a>
<img>
<h1>
<img>

tags that don't work

attributes that don't work

target="_blank"

Badges

Badges are adjustable Image Links(URLs) to an Online Third-Party Image Generator

URL Syntax/Structure:

https: //img.shields.io/badge/ leftText - rightText - rightBG ?style = btnDesign & logo = logoName & logoColor = HexColor & labelColor = HexColor

e.g.

https://img.shields.io/badge/YouTube-red?style=for-the-badge&logo=youtube&logoColor=white&color=white

https://img.shields.io/static/v1?message=html&logo=css3&labelColor=5c5c5c&color=1182c3&logoColor=white&label=%20&style=plastic

https://img.shields.io/badge/Medium-black?style=for-the-badge&logo=medium&logoColor=red

! Dont stretch badges by setting width & height (doesnt look right) !

Colors