I prefer to use
Markdown for basically everything I can, from writing a personal blog, tech articles and even my resume. There are only a few syntaxes that I most commonly use. This post is intended for those who are new to
Markdown or need a refresh on its syntax.
Heading and List
# symbol is used for creating a heading.
# is for
## is for
H2. You can use up to 6
You can make an unordered list with
*. To make an ordered list, use a a number. Below is an example of using heading and list.
#Why markdown? (H1) ##Reasons I like markdown (H2) - Minimal, clean and less distraction for writing - Good support for code blocks - Can be exported to many formats including html, pdf, doc, latex, etc. ##My favorite markdown editors (H2) 1. Typora (Mac, Window) 2. Caret (Mac, Window) 3. Bear (Mac app store)
Reasons I like markdown
- Minimal, clean and less distracting for writing
- Good support for code blocks
- Can be exported to many formats including html, pdf, doc, latex, etc.
My favorite markdown editors
- Typora (Mac, Window)
- Caret (Mac, Window)
- Bear (Mac app store)
You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted. To format code or text into its own distinct block, use triple backticks.
``` def foobaz(): print("you can use ` for code snippet") ```
def foobaz(): print("you can use ` for code snippet")
- [ ] Write an article weekly - [ ] Repair windshield wipers of car 🚘 - [x] Publish **this** to dev.to
- [ ] Write an article weekly
- [ ] Repair windshield wipers of car and add washer fluid 🚘
- [x] Publish this to dev.to
**STRONG** *emphasis* ~~strikethrough~~ Math $e=mc^2$ Use *** or - - - for horizontal rule
: will bring up a list of suggested emojis, i.e
:EMOJICODE:. For a full list of emojis, check out https://www.webpagefx.com/tools/emoji-cheat-sheet/
`:unicorn:` :unicorn: `:+1:`:+1:
:unicorn: :unicorn: (dev.to does not support emoji?)
Link and Image
There are two ways to make links for text and images, inline and references.
[link title](uri). Inline link can be be absolute or relative URIs (link within local resources).
[link][refereceID] is different from inline link in that it is using a
 for the second part instead of
(). Also, you need to add an
id reference later, so that markdown can link them together.
[referenceID] : www.google.com "Google"
Image is similar to inline and reference links, but there is an extra
! in in front.
![Cat Image](catURI) or
[Reference link to dev.to website](dev.to) ![image](https://i2.wp.com/fullstop360.com/blog/wp-content/uploads/2017/05/design-quotes-for-inspiration-2.jpg?)
You can Use [toc] to create Table of Content.
Inline html and
<span style="color: red">Red Text</span>
Red Text (should be red on fully supported Markdown editor)
>And so, my fellow Americans: ask not what your country can do for you — ask what you can do for your country
And so, my fellow Americans: ask not what your country can do for you — ask what you can do for your country