Skip to content

GitHub Formatting

Eli edited this page Jul 14, 2022 · 2 revisions

Styling with Github

Just testing GitHub Repo's. Here's a list of all styling options and how to use them!

Basic Text Formatting:

Styling Instructions
Bold Use ** before and after your text
Italics Use * before and after
Bold & Italics Put *** before and after the text
Strikethrough Use ~~ before and after
subscript Put </sub> before and </sub> after your text
superscript Put <sup> before and </sup> after your text

More Formatting Styles:

Quoting Text

Quoting text

Put > at the beginning of the line

Quoting code

Quoting code Put ` before and after your text

Code Blocks

Code Blocs

Place three backticks (```) on a line before and a line after your code block

Colour Formatting:

Just put a backtick (`) before and after the colour code.

Example: The background colour should be #ffffff for light mode and #0d1117 for dark mode.

Demo:
hsl(222, 51%, 36%)
rgb(45, 73, 139)
#0969DA

Links & Images

To create linked text, put square braces around the text you want to link, and follow it with the link in rounded brackets. Example: This site was built using [GitHub Pages](https://pages.github.com/). Output: This site was built using GitHub Pages.

To embed an image, first use an exclamation mark, next put the alt text in squared brackets, followed by the image link in rounded brackets. Example: ![This is an image alt text](https://myoctocat.com/assets/images/base-octocat.svg)


See the full and original docs here: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax