Notepad/enter/Coding Tips (Classical)/Terminal Tips/2. CLI Tools/Languages/High level - Front-end/Markdown.md

167 lines
4.4 KiB
Markdown
Raw Permalink Normal View History

2023-07-05 18:29:11 +00:00
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. :)
2024-08-10 14:43:25 +00:00
View [this Markdown guide](https://daringfireball.net/projects/markdown/syntax) by John Gruber, the inventor of Markdown.
2023-07-14 20:02:45 +00:00
Use Cases:
- markdown is used right here! in obsidian!
- markdown for [MkDocs](https://www.mkdocs.org/)
- a bunch of other cool MKDocs features in [catalog](https://github.com/mkdocs/catalog#-theming)
2024-08-10 14:43:25 +00:00
- markdown is used in wikipedia, although their own version of it
- Also [CommonMark](https://commonmark.org/)
2023-07-15 23:43:44 +00:00
- markdown [cheatsheet of emojis](https://github.com/ikatyang/emoji-cheat-sheet#face-smiling) :lotus_position:
2023-07-15 23:48:40 +00:00
- here is a[ full unicode list of emojis ](https://unicode.org/emoji/charts/full-emoji-list.html)from all different companies as well
2023-07-24 03:10:28 +00:00
- For Wikipedia specific markdown, visit this [cheatsheet](https://wiki.codeblocks.org/index.php/Help:Editing)
2023-07-24 08:00:06 +00:00
- a[ typing svg for md](https://github.com/DenverCoder1/readme-typing-svg) readme's!
- ![input](https://camo.githubusercontent.com/99920570356a774a77180472b749928383a48f2e4f04f088475002029abb4c42/68747470733a2f2f726561646d652d747970696e672d7376672e64656d6f6c61622e636f6d2f3f6c696e65733d547970652b6d657373616765732b65766572797768657265213b4164642b612b62696f2b746f2b796f75722b70726f66696c65213b4164642b612b6465736372697074696f6e2b746f2b796f75722b7265706f213b4d616b652b796f75722b726561646d652b7374616e642b6f75742126666f6e743d46697261253230436f64652663656e7465723d747275652677696474683d333830266865696768743d3530266475726174696f6e3d343030302670617573653d31303030)
- Also [Online Markdown editor](https://pandao.github.io/editor.md/en.html) exists, with [themes](http://editor.md.ipandao.com/examples/themes.html#Default%20theme)!
- When going from JS to Markdown they often integrate [Marked](https://marked.js.org) which is a compiler for Markdown specifically
- Of course, there are [so many](https://ourcodeworld.com/articles/read/926/top-5-best-electron-framework-based-markdown-note-taking-applications) markdown editors
2024-08-10 14:43:25 +00:00
- The most popular of which is [StackEdit](https://stackedit.io/app#)
2023-07-14 20:02:45 +00:00
---
Code phrases: Actually the following list is all in Markdown but follow the link to see it in plaintext.
2023-07-05 18:29:11 +00:00
---
2023-07-14 20:02:45 +00:00
# Markdown Cheat Sheet
Thanks for visiting [The Markdown Guide](https://www.markdownguide.org)!
This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It cant cover every edge case, so if you need more information about any of these elements, refer to the reference guides for [basic syntax](https://www.markdownguide.org/basic-syntax) and [extended syntax](https://www.markdownguide.org/extended-syntax).
## Basic Syntax
These are the elements outlined in John Grubers original design document. All Markdown applications support these elements.
2023-07-24 03:10:28 +00:00
```
### Heading
# H1
## H2
### H3
```
2023-07-14 20:02:45 +00:00
### Heading
# H1
## H2
### H3
2023-07-24 03:10:28 +00:00
`**bold text**`
**bold text**
2023-07-14 20:02:45 +00:00
2023-07-24 03:10:28 +00:00
`*italicized text*`
2023-07-14 20:02:45 +00:00
*italicized text*
2023-07-24 03:10:28 +00:00
`> blockquote`
2023-07-14 20:02:45 +00:00
> blockquote
### Ordered List
1. First item
2. Second item
3. Third item
### Unordered List
- First item
- Second item
- Third item
### Code
`code`
### Horizontal Rule
---
### Link
[Markdown Guide](https://www.markdownguide.org)
### Image
![alt text](https://www.markdownguide.org/assets/images/tux.png)
## 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]
[^1]: This is the footnote.
### Heading ID
### My Great Heading {#custom-id}
### Definition List
term
: definition
### Strikethrough
~~The world is flat.~~
### Task List
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
### Emoji
That is so funny! :joy:
(See also [Copying and Pasting Emoji](https://www.markdownguide.org/extended-syntax/#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:
```bash
pandoc input.md -t pdf -o output.pdf
```
or the following online converters - mathpix.com