Markdown Helpers can be toggled on or off - feel free to check out Markdown Tips for a full list of Markdown operations along with keyboard shortcuts.
Shortcut uses a modified version of the popular text formatting syntax Markdown. For a complete reference, visit http://daringfireball.net/projects/markdown/syntax
Headers
# This is a header.
## This is a subheader.Emphasis
*This text will be italic.*
_This will also be italic._
**This text will be bold.**
__This will also be bold.__Unordered Lists
* Item 1
* Item 2
* Item 2a
* Item 2bOrdered Lists
1. Item 1
2. Item 2
* Item 2a
* Item 2bTask List
- [x] First item
- [ ] Second item
- [ ] Third itemBlockquotes
> The HTML blockquote Element
> indicates that the enclosed
> text is an extended quotation.Mermaid
We now support Mermaid in Markdown!
Please Note:
- Mermaid diagrams currently are only supported in:
- Story and Epic descriptions and comments
- Objective and Iteration descriptions.
- Mermaid diagrams are not supported in Docs at this time.
When on a Story, Epic, Objective, or Iteration, simply add mermaid after the initial code block formatting.
For example,
```mermaid
---
title: Order example
---
erDiagram
CUSTOMER ||--o{ ORDER : places
ORDER ||--|{ LINE-ITEM : contains
CUSTOMER }|..|{ DELIVERY-ADDRESS : usesFor reference, check out the Mermaid Docs for Markdown for examples of entity relationship diagrams.
Strikethrough
~~This text will be strikethroughed~~Tables
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content CellEmoji
:zap: :bowtie: :zap:You can also copy Emojis from http://www.emoji-cheat-sheet.com into Shortcut.
Images
Links
[Example](http://example.com)
Plain old URLs work too!
http://example.comStory Links
This is blocked by #123.
See also: #345, #1102
ch415
https://app.shortcut.com/flyingrobots/story/39/story-markdown
https://app.shortcut.com/flyingrobots/story/39
Inline code
Your code is missing the `var` keyword.Code blocks
Without syntax highlighting:
```
body {
text-decoration: blink;
}
```
With syntax highlighting:
```js
var myCoolRollover = new Image();
myCoolRollover.src = 'myCoolRollover.gif';
```
Available highlighters:
coffeescript, apache, http, cs, java, sql, nginx, xml, diff, javascript, clojure, go, bash, objectivec, markdown, json, python, ruby, cpp, css, php, perl, ini, makefileUpdated