Github Markdown Cheatsheet

Text Formatting

Official Documentation can be found in the Github Docs

Formatting	Markdown	Example	Output
Bold	** ** or __ __	**This is bold text**	This is bold text
Italics	* * or _ _	_This text is italicized_	This text is italicized
Strikethrough	~~ ~~	~~This was mistaken text~~	T̶h̶i̶s̶ ̶w̶a̶s̶ ̶m̶i̶s̶t̶a̶k̶e̶n̶ ̶t̶e̶x̶t̶
Subscript	<sub> </sub>	This is a <sub>subscript</sub> text	This is a subscript text
Superscript	<sup> </sup>	This is a <sup>superscript</sup> text	This is a superscript text

Callouts

Documentation on this feature can be found in the Github Discussions

> [!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.

Badges

More Advanced Documentation can be found here

For Licensing Badges, go view them on this Github gist

Badges	Markdown	Output
Workflow Status	
Code Coverage	[](https://my-app.com/coverage/report.html)
License	[](https://opensource.org/licenses/Apache-2.0)
Contributors	
Issues	
Pull Request