Too Long, Didn't read: GitHub Flavored Markdown Spec
If you can read chinese, read this first then my file Markdown 是什么?
I suggest you to read the Raw file first then see this rendered page.
Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML.
You might consider it is something better than MS Word. In github repository, readme.md is a .md file, which md stands for Markdown.
- Support Everywhere
- Easy to learn
- Quick and clean
- Easy On The Eyes
- Sytlish code showcase
I personally recommend Typora (Support Linux, Windows, MacOS
- If you use vscode, notice you need to install this plugin: Markdown-all-in-one
# H1
## H2
### H3
#### H4
##### H5
###### H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
======
Alt-H2
------[I'm an inline-style link](https://www.google.com)1. First ordered list item
2. Another item
⋅⋅* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
⋅⋅1. Ordered sub-list
4. And another item.
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅
⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
* Unordered list can use asterisks
- Or minuses
+ Or pluses- First ordered list item
- Another item ⋅⋅* Unordered sub-list.
- Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list
- And another item.
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
- Unordered list can use asterisks
- Or minuses
- Or pluses
```javascript
var s = "JavaScript syntax highlighting";
alert(s);
```
```python
s = "Python syntax highlighting"
print s
```
```
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
```
In markdown, we use Latex if you want to put some fancy Mathematical expression.
Note that
- Both Typora and VSCode support Latex syntax.
- Github Flavored Markdown doesn't support Latex syntax.
But We still welcome you guys to use it when needed.
Notice here 'XXX' is the ID of the image.
You'll need to grab the ID of the image. Easiest way on the desktop is to right click the file, dive into the Google Drive subcontext menu and choose View on the Web. Grab the string of characters from there and replace the XXX in the code below with it.
I strongly recommand uploading the photos on imgur then link it back.
Upload the image to Imgur then link it back.