4.4 KiB
You will inevitably learn a bunch about markdown simply from using Obsidian which is all full of just markdown files. Any tips and tricks that you do learn though can all go here. Happy marking down. :)
View this Markdown guide by John Gruber, the inventor of Markdown.
Use Cases:
- markdown is used right here! in obsidian!
- markdown for MkDocs
- a bunch of other cool MKDocs features in catalog
- markdown is used in wikipedia, although their own version of it
- Also CommonMark
- markdown cheatsheet of emojis 🧘
- here is a full unicode list of emojis from all different companies as well
- For Wikipedia specific markdown, visit this cheatsheet
- a typing svg for md readme's!
- Also Online Markdown editor exists, with themes!
- When going from JS to Markdown they often integrate Marked which is a compiler for Markdown specifically
- Of course, there are so many markdown editors
- The most popular of which is StackEdit
Code phrases: Actually the following list is all in Markdown but follow the link to see it in plaintext.
Markdown Cheat Sheet
Thanks for visiting The Markdown Guide!
This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.
Basic Syntax
These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.
### Heading
# H1
## H2
### H3
Heading
H1
H2
H3
**bold text**
bold text
*italicized text*
italicized text
> blockquote
blockquote
Ordered List
- First item
- Second item
- Third item
Unordered List
- First item
- Second item
- Third item
Code
code
Horizontal Rule
Link
Image
Extended Syntax
These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.
Table
| Syntax | Description |
|---|---|
| Header | Title |
| Paragraph | Text |
Fenced Code Block
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
Footnote
Here's a sentence with a footnote. 1
Heading ID
My Great Heading
Definition List
- term
- definition
Strikethrough
The world is flat.
Task List
- Write the press release
- Update the website
- Contact the media
Emoji
That is so funny! 😂
(See also Copying and Pasting Emoji)
Highlight
I need to highlight these ==very important words==.
Subscript
H~2~O
Superscript
X^2^
Convert Markdown to PDF
Do this easily with Python by installing pandoc and running the following command:
pandoc input.md -t pdf -o output.pdf
or the following online converters - mathpix.com
-
This is the footnote. ↩︎