Create sophisticated formatting for your prose and code on GitHub with simple syntax.
Headings
To create a heading, add one to six # symbols before your heading text. The number of # you use will determine the hierarchy level and typeface size of the heading.
A first-level heading ## A second-level heading ### A third-level heading

When you use two or more headings, GitHub automatically generates a table of contents that you can access by clicking within the file header. Each heading title is listed in the table of contents and you can click a title to navigate to the selected section.

Styling text
You can indicate emphasis with bold, italic, strikethrough, subscript, or superscript text in comment fields and .md files.
StyleSyntaxKeyboard shortcutExampleOutputBold or Command+B (Mac) or Ctrl+B (Windows/Linux)This is bold textThis is bold textItalic or Command+I (Mac) or Ctrl+I (Windows/Linux)This text is italicizedThis text is italicizedStrikethrough~~ ~~This was mistaken textThis was mistaken textBold and nested italic and This text is extremely importantThis text is extremely importantAll bold and italic* **All this text is important*All this text is importantSubscriptThis is a subscript textThis is a subscript textSuperscriptThis is a superscript textThis is a superscript text
Quoting text
You can quote text with a >.
Text that is not a quote > Text that is a quote
Quoted text is indented, with a different type color.
tuanggolt
commented
1 year ago
Writing on GitHub/
Start writing on GitHub/
Basic formatting syntax
Basic writing and formatting syntax
In this article
Headings
Styling text
Quoting text
Quoting code
Supported color models
Links
Section links
Relative links
Images
Lists
Task lists
Mentioning people and teams
Referencing issues and pull requests
Referencing external resources
Uploading assets
Using emoji
Paragraphs
Footnotes
Hiding content with comments
Ignoring Markdown formatting
Disabling Markdown rendering
Further reading
Create sophisticated formatting for your prose and code on GitHub with simple syntax.
Headings
To create a heading, add one to six # symbols before your heading text. The number of # you use will determine the hierarchy level and typeface size of the heading.
A first-level heading ## A second-level heading ### A third-level heading

When you use two or more headings, GitHub automatically generates a table of contents that you can access by clicking within the file header. Each heading title is listed in the table of contents and you can click a title to navigate to the selected section.

Styling text
You can indicate emphasis with bold, italic, strikethrough, subscript, or superscript text in comment fields and .md files.
StyleSyntaxKeyboard shortcutExampleOutputBold or Command+B (Mac) or Ctrl+B (Windows/Linux)This is bold textThis is bold textItalic or Command+I (Mac) or Ctrl+I (Windows/Linux)This text is italicizedThis text is italicizedStrikethrough~~
~~This was mistaken textThis was mistaken textBold and nested italic and This text is extremely importantThis text is extremely importantAll bold and italic* **All this text is important*All this text is importantSubscript This is a subscript textThis is a subscript textSuperscript This is a superscript textThis is a superscript textQuoting text
You can quote text with a >.
Text that is not a quote > Text that is a quote
Quoted text is indented, with a different type color.
8052023092415.jpg …]()
![Uploading images - 2023-05-18T091538.159.jpeg …]()
!
8T091019.984.jpeg …]()
![Uploading images - 2023-05-18T090952.703.jpeg …]()
Originally posted by @Joannofwales84 in https://github.com/jlord/sheetsee.js/issues/26#issuecomment-1553709894