Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on Flaw Tech. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.
Headings
# This is an <h1> tag
## This is an <h2> tag
### This is an <h3> tag
#### This is an <h4> tag
##### This is an <h5> tag
###### This is an <h6> tag
Emphasis
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
_You **can** combine them_
Result:
This text will be italic
This will also be italic
This text will be bold
This will also be bold
You can combine them
Lists
Inordered:
* Milk
* Bread
* Wholegrain
* Butter
Result:
Ordered:
1. Tidy the kitchen
2. Prepare ingredients
3. Cook delicious things
Result:
- Tidy the kitchen
- Prepare ingredients
- Cook delicious things
Images
Result:
Links
[link](https://example.com)
Result:
link
Blockquotes
As Kanye West said:
> We're living the future so
> the present is our past.
Result:
As Kanye West said:
We're living the future so
the present is our past.
Horizontal Rules
---
Result:
Code Snippets
Indenting by 4 spaces will turn an entire paragraph into a code-block.
Result:
.my-link {
text-decoration: underline;
}
Reference Lists & Titles
**The quick brown [fox][1], jumped over the lazy [dog][2].**
[1]: https://en.wikipedia.org/wiki/Fox "Wikipedia: Fox"
[2]: https://en.wikipedia.org/wiki/Dog "Wikipedia: Dog"
Result:
The quick brown fox, jumped over the lazy dog.
Escaping
\*literally\*
Result:
*literally*
Advanced Markdown
Note: Some syntax which is not standard to native Markdown. They're extensions of the language.
Strike-throughs
~~deleted words~~
Result:
deleted words
Automatic Links
https://ghost.org
Result:
https://ghost.org
Markdown Footnotes
The quick brown fox[^1] jumped over the lazy dog[^2].
[^1]: Foxes are red
[^2]: Dogs are usually not red
Result:
The quick brown fox[1] jumped over the lazy dog[2].
[1]: Foxes are red
[2]: Dogs are usually not red
Username @mentions
Typing an @ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.
Emoji
We support emoji as well! Check out the Emoji Cheat Sheet.
References
