Headings:
Styling text:
Bold
Italic
Strikethrough
Bold and nested italic
All bold and italic
Textsubscript
Textsuperscript
Quoting code:
1) To call out code
2) To call a command
git status
git add
git commit
Supported color models:
HEX:
#RRGGBB
#0969DA
RGB:
rgb(R,G,B)
rgb(9,105,218)
HSL:
hsl(H,S,L)
hsl(212, 92%, 45%)
Notes: 1) A supported color model cannot have any leading or trailing spaces within the backticks.
2) The visualization of the color is only supported in issues, pull requests, and discussions.
Links: This site was built using https://github.com/billysamplecode Section links: # A first-level heading with Section links Relative links: Relative links
Specifying the theme an image is shown to:
Lists: Unordered Lists:
- Unordered ListItem1
- Unordered ListItem2
- Unordered ListItem3
- Unordered ListItem4
- Unordered ListItem5
- Unordered ListItem6
- Unordered ListItem7
- Unordered ListItem8
- Unordered ListItem9
Ordered Lists:
- Ordered ListItem3
- Ordered ListItem2
- Ordered ListItem1
- Ordered ListItem6
- Ordered ListItem5
- Ordered ListItem4
- Ordered ListItem9
- Ordered ListItem8
- Ordered ListItem7
Nested Lists:
- First ListItem1
- First NestedListItem1
- Second NestedListItem2
- First NestedListItem1
Nested Lists in comment editor on GitHub: 100. First ListItem1 - First NestedListItem1 100. First ListItem1 - First NestedListItem1 - Second NestedListItem2
Task lists:
- [] TaskItem1
- TaskItem2MarkedWithX
- (TaskItem3ItemDescriptionBeginsWithAParenthesis,EscapeWith\AtFront)
Mentioning people and teams: @billysamplecode
Referencing issues and pull requests: #TypeThisSymbol To bring up a list of suggested issues and pull requests within the repository by typing #
Referencing external resources: Repository administor has ability to create custom autolink references to external resources.
Uploading assets: You can upload assets like images by dragging and dropping, selecting from a file browser, or pasting. You can upload assets to issues, pull requests, comments, and .md files in your repository.
Using emoji: You can add emoji to your writing by typing :EMOJICODE:, a colon followed by the name of the emoji. For a full list of available emoji and codes see: the Emoji-Cheat-Sheet
Paragraphs: You can create a new paragraph by leaving a blank line between lines of text.
Footnotes: You can add footnotes to your content by using this bracket syntax:
Here is a simple footnote1.
A footnote can also have multiple lines2.
Alerts:
Five types of alerts are available:
Note
Useful information that users should know, even when skimming content.
Tip
Helpful advice for doing things better or more easily.
Important
Key information users need to know to achieve their goal.
Warning
Urgent info that needs immediate user attention to avoid problems.
Caution
Advises about risks or negative outcomes of certain actions.
Hiding content with comments:
You can tell GitHub to hide content from the rendered Markdown by placing the content in an HTML comment. <!--InputToHideCommentsHere-->
Disabling Markdown rendering: Click Code at the top of the file to disable Markdown rendering and view the file's source instead. Disabling Markdown rendering enables you to use source view features, such as line linking, which is not possible when viewing rendered Markdown files.