Contents

1. 前言
2. 行文常用語法
   1. 標題
   2. 強調(diào)
   3. 列表
   4. 引用
   5. 代碼
   6. 分割線
3. 其他基本語法
   1. 表格
   2. 圖像
   3. 鏈接
   4. 公式
   5. 反斜線
   6. 腳注
4. 結(jié)語

Introduction

這次來美國三個多月了，由于研究的需要侧但，一直在用jupyter lab處理實驗數(shù)據(jù)矢空。熟悉jupyter notebook或jupyter lab的朋友可能都知道，在這兩個應(yīng)用里面可以使用Markdown語法對程序進行注釋禀横，甚至有些大牛會直接在notebook里面撰寫論文屁药，當然這需要安裝一些額外的extension，有興趣的朋友可以到這位Julius Schulz大神的博客學(xué)習：MAKING PUBLICATION READY PYTHON NOTEBOOKS柏锄。

寫這篇文章的主要目的有兩個：一是作為自己的學(xué)習筆記和總結(jié)酿箭；二是希望能為感興趣的朋友提供一個簡明的入門教程复亏。因此，本文介紹的都是Markdown最基本的用法缭嫡，其中內(nèi)容主要參考了GitHub Guides缔御。此外，還參考了簡書上一位作者ZD9503的文章妇蛀，在此表示感謝耕突。先來一張Von Gogh名畫的python版吧（相信了解matplotlib的朋友應(yīng)該知道我想表達什么吧？是的评架，viridis！）：

Stevedores in Arles

Syntax guide

好了纵诞，言歸正傳上祈，下面簡單介紹一下markdown的基本語法挣磨。

Headers（標題）

幾級標題就用幾個"#"掉蔬，最多支持六級標題壕翩。

# this is a <h1> tag（一級標題）
## This is an <h2> tag（二級標題）
###### This is an <h6> tag（六級標題）

Emphasis（強調(diào)）

強調(diào)是通過在文字兩側(cè)加入星號（*）珍策、下劃線（_）和波浪線（~）等符號實現(xiàn)的疗绣，注意符號和需要強調(diào)的文字之間沒有空格！

*This text will be italic*（包括在兩個*之間的文字為斜體鹏溯，其他類似）
_This will also be italic_（斜體）
**This text will be bold**（黑體）
__This will also be bold__（黑體）
~~This text will be deleted~~（刪除線）
_You **can** combine them_（可以多種格式復(fù)合使用）

List（列表）

Unordered（無序列表）

無序列表用 - + * 任何一種都可以，注意符號和文字之間有空格！

* Item 1
* Item 2
?*Item 2a
?*Item 2b

Ordered（順序列表）

使用數(shù)字加點的方式，數(shù)字和點之間沒有空格，而點和后面的文字之間有空格！無序列表和有序列表都可以進行嵌套查刻。

1.?Item 1
1.?Item 2
?*Item 2a（無序）
?*Item 2b（無序）
1.?Item 3
?1.?Item 3a
?1.?Item 3b

Blockquotes（引用）

引用的內(nèi)容可以用 >來表示，比如本文中所有對命令的說明都采用了引用的方式仔沿。

> We're living the future so
> the present is our past.

Code（代碼）

Inline code（行內(nèi)代碼）

代碼之間分別用一個反引號（`）包起來奴艾。

` print 'Hello world!' `

Code blocks（代碼塊）

連用三個反引號（```）將代碼包起來。

```
def f(x):
??return x**2 + 2*x + 1
```

效果如下：

def f(x):
    return x**2 + 2*x + 1

Horizontal rules（分割線）

三個或者三個以上的 - 或者 * 都可以脊阴。

---
***

效果如下：

Useful syntax（插入對象）

這一部分主要介紹如何插入一些有用的對象握侧，比如表格、圖像和公式等嘿期，以及其他一些有用的語法品擎。

Tables（表格）

表格的插入非常簡單，只需要按照如下語法畫出表格形狀即可备徐，在編輯代碼時不需要考慮對齊（但是為了美觀和邏輯的直觀萄传，建議代碼整齊）。豎線（|）用于分欄蜜猾，短橫線（-）用于分割表頭和其余部分秀菱，冒號（:）用于標記表格內(nèi)容的對齊方式（默認為左對齊）。如果嫌麻煩蹭睡，這里有個神奇的表格生成網(wǎng)站衍菱，可以直接生成你所需要的代碼，而且不止有Markdown代碼肩豁，還有Latex和HTML代碼脊串！

|表頭|表頭|表頭|
|:-------|:------:|------:|
|內(nèi)容|內(nèi)容|內(nèi)容|
|內(nèi)容|內(nèi)容|內(nèi)容|
|內(nèi)容|內(nèi)容|內(nèi)容|

效果如下：

Images（圖像）

用  可以添加在線圖片或本地圖片辫呻，其中標題為可選項。添加本地圖片需要注意琼锋，使用jupyter notebook或lab的時候放闺，圖片必須放在程序所在文件夾或所在文件夾的子文件夾下！

（添加在線圖片）
（添加本地圖片）

Von Gogh.jpg

Links（鏈接）

用 [名稱](地址 "標題") 可以添加超鏈接缕坎，語法和添加圖片類似怖侦，只是少了嘆號。

[GitHub](http://github.com "title")

Equations（公式）

公式的編輯采用Latex語法谜叹，如果讀者對Latex語法不熟悉匾寝，同樣為大家提供一個神奇的網(wǎng)站。
這是行內(nèi)公式：

$E=mc^2$（）

這是公式塊：

$$
e^{i\theta} = \cos \theta +i\sin \theta \
e^z = 1 + \frac{z}{1!} + \frac{z^2}{2!} + \frac{z^3}{3!} + \cdots = \sum_{n=0}^{\infty}\frac{z^n}{n!}
$$

效果如下：

Backslash（反斜線）

如果想要插入以上內(nèi)容中用到的一些符號（字面上荷腊，而非功能性應(yīng)用）旗吁，比如希望插入星號（*），但不是用這個星號來表示斜體或加粗等停局，那么可以在符號前面加反斜線（\）以插入這些普通符號。

\ 反斜線
` 反引號
* 星號
_ 底線
{} 花括號
[] 方括號
() 括弧
# 井字號
+ 加號
- 減號
. 英文句點
! 驚嘆號

Footnotes（腳注）

腳注可以用于編輯參考文獻^[1]香府。

在文中使用[^1]的方式標記腳注董栽，
在文末使用[^1]:加入?yún)⒖嘉墨I，注意要使用英文冒號企孩，后面有無空格均可锭碳。

Summary（結(jié)語）

Markdown是一種所謂的輕量級標記語言（lightweight markup language），它可以讓我們在寫文章的時候?qū)Ｗ⒂趯懽鞅旧砦鹆В挥萌ス芘虐娴膯栴}擒抛，這種思想是和大名鼎鼎的Latex一致的。像簡書补疑、GitHub和Gitlab等許多網(wǎng)站歧沪，都采用Markdown來進行文本編輯。目前有很多流行的Markdown編輯器莲组，筆者自己用的是Typora诊胞，這是一款免費軟件，功能強大锹杈，界面優(yōu)雅撵孤，大家可以試試。本文簡要介紹了Markdown最基本的語法和常用功能竭望，希望能對初次接觸這一語言的朋友有所幫助邪码。

1. 這是一個參考文獻。 ?