Skip to content

Latest commit

 

History

History
93 lines (73 loc) · 5.15 KB

README.md

File metadata and controls

93 lines (73 loc) · 5.15 KB
Raw

Markdown Mini Guide

This guide is a basic mini-summary of the Official GitHub Guide This guide includes the markdown system used by GitHub and the system used by Discord. The first section is from GitHub and the second from Discord. I hope you find it useful. c:

GitHub

Types

Name Syntax Keyboard shortcut Example Output
Heading Big # None # This is a big text # This is a big text
Heading Medium ## None # This is a medium text ## This is a medium text
Heading Small ### None # This is a small text ### This is a small text
Bold ** ** or __ __ Command+B (Mac) or Ctrl+B (Windows/Linux) **This is bold text** This is bold text
Italic * * or _ _      Command+I (Mac) or Ctrl+I (Windows/Linux) _This text is italicized_ This text is italicized
Strikethrough ~~ ~~ None ~~This was mistaken text~~ This was mistaken text
Bold and nested italic ** ** and _ _ None **This text is _extremely_ important** This text is extremely important
All bold and italic *** *** None ***All this text is important*** All this text is important
Subscript <sub> </sub> None <sub>This is a subscript text</sub> This is a subscript text
Superscript <sup> </sup> None <sup>This is a superscript text</sup> This is a superscript text
Quoting Text > None > This is a quoting text > This is a quoting text
Quoting Code `` None This is a quoting code This is a quoting code
Checkmark True - [x] text None - [x] This is a checkmark true example - [x] This is an example
Checkmark False - [ ] text None - [ ] This is a checkmark false example - [ ] This is an example
Keyboard Keys Markup <kbd> </kbd> None <kbd>This is a Keyboard key example</kbd> This is a Keyboard key example
Note Highlights > [!NOTE] None > [!NOTE] [ENTER] > note... > [!NOTE] [ENTER] > note...
Warning Highlights > [!WARNING] None > [!WARNING] [ENTER] > warning... > [!WARNING] [ENTER] > warning...
Important Highlights > [!IMPORTANT] None > [!IMPORTANT] [ENTER] > important... > [!IMPORTANT] [ENTER] > important...
Tip Highlights > [!TIP] None > [!TIP] [ENTER] > important... > [!TIP] [ENTER] > important...
Caution Highlights > [!CAUTION] None > [!CAUTION] [ENTER] > important... > [!CAUTION] [ENTER] > important...

Outputs not checked in the list

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

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

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

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

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

Note

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

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Quoting Text

  • Checkmark true
  • Checkmark false

Mqxx has a very interesting GitHub Markdown document. There he shows more types of signs like Warning and Note but artificial, and they look as if they were original and official. I invite you to see its repository: https://github.com/Mqxx/GitHub-Markdown

Discord

Types

Name Syntax Example Output
Heading Big # # This is a big text # This is a big text
Heading Medium ## # This is a medium text ## This is a medium text
Heading Small ### # This is a small text ### This is a small text
Bold ** ** **This is bold text** This is bold text
Italic * * or _ _ _This text is italicized_ This text is italicized
Strikethrough ~~ ~~ ~~This was mistaken text~~ This was mistaken text
Underlined __ __ __This was mistaken text__ This was underlined text
Spoiler || || || This was mistaken text || ||This was underlined text||
Bold and nested italic ** ** and _ _ **This text is _extremely_ important** This text is extremely important
All bold and italic *** *** ***All this text is important*** All this text is important
Quoting Text > > This is a quoting text > This is a quoting text
Quoting Code `` This is a quoting code This is a quoting code
Link [Word](link) [Google](https://google.com) Google