developersung13 / github-markdown

This is a repository that shares custom profiles units so that you can design your own profile in a variety of ways in GitHub.

GitHub Markdown

Here are a few markdown additions and hints for GitHub Markdown.

Also check out this Gist for mor information about GitHub markdown.

Blockquotes(Beta)

Note

Note

Highlights information that users should take into account, even when skimming.

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

Tip

Tip

Optional information to help a user be more successful.

> [!TIP]
> Optional information to help a user be more successful.

Important

Important

Crucial information necessary for users to succeed.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

Warning

Warning

Critical content demanding immediate user attention due to potential risks.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

Caution

Caution

Negative potential consequences of an action.

> [!CAUTION]
> Negative potential consequences of an action.

Tooltips

This is how you can add your own tooltips or hover texts. You can create a tooltip by using two ## instead of an actual link. For some reason, Markdown links that come directly after a bracket are sometimes invisible within a table. You can avoid this by linking directly to your file (For example insted of ## use README.md##). The goal is to have no click effect on the tooltips. They should only look like a link so that you can more easily find the tooltip.

Basic

[This is an example text that looks like a link, but nothing happens when you click on it.](## 'And this is the hover text.')

This is an example text that looks like a link, but nothing happens when you click on it.

Linebreaks

You can also create linebreaks inside your tooltip by using the 
 HTML sequence.

[Example text.](## 'Tooltip with
linebreak')

Example text.

Inside Table

You can also use tooltips inside a table, like so.

|      A      |      B      |
| :---------: | :---------: |
| Info[\*][1] | Text[\*][2] |

[1]: ## 'Hover Info'
[2]: ## 'Hover Text'

A	B
Info*	Text*

Keybindings/Keyinserts

You can insert keyboard keys into your markdown as well. To do that use the <kbd> and </kbd> tag.

Basic

Use <kbd>Ctrl</kbd>+<kbd>S</kbd> to save your file.

Use Ctrl+S to save your file.

Nesting

Nesting is also possible.

Hold <kbd><kbd>Ctrl</kbd>+<kbd>Shift</kbd></kbd> and press <kbd>A</kbd> to select all text.

Hold Ctrl+Shift and press A to select all text.