used in Gist, comments, issues, pull requests and .md
and .markdown
extension files.
- paragraphs are separated by one or more blank lines
- heading from
#
to######
- blockquote
>
- bold <strong>
**
or__
- italic <em>
*
or_
- unordered list
*
or-
- ordered list
1.
,2.
,3.
, ... - nested list by two spaces indentation
- inline code
`
(no special formatting applied) - pre-formatted code block with leading four spaces (eight spaces in lists)
- link
[text](url)
- image

- ignore underscores in words
do_this_and_do_that_and_another_thing
- URL autolink
- strikethrough
~~Mistaken text.~~
- fenced code block
```
without leading four spaces - syntax highlight
```ruby
- table with optional leading and trailing pipe
Left-Aligned | Center Aligned | Right Aligned
:------------ |:---------------:| -----:
col 3 is | some wordy text | $1600
- HTML allowed elements and attributes
- newline in comments as real line breaks
- task lists
[ ]
and[x]
in lists - reference to commits and issues
- SHA: a5c3785ed8d6a35868bc169f07e40e889087fd2e
- User@SHA: jlord@a5c3785ed8d6a35868bc169f07e40e889087fd2e
- User/Repository@SHA: jlord/sheetsee.js@a5c3785ed8d6a35868bc169f07e40e889087fd2e
- #Num: #26
- GH-Num: GH-26
- User#Num: jlord#26
- User/Repository#Num: jlord/sheetsee.js#26
- emoji
- Keyboard shortcuts: reply with qoute
r
,@mention
,:emoji
,#issue
- fullscreen (Zen Mode)
- cons - no automatic toc, no color styling, no headless table
Reference