目錄
- 文檔利器-Markdown
- 1.1、标題文法#1-#6
- H1
- H2
- 1.2、清單
- 1.3、引用
- 1.4、重點強調
- 1.5、連結LINK
- 1.6、單詞高亮
- 1.7、表格
- 1.8、代碼塊
- 1.9、圖檔
- 2、文檔規範
- 3、markdown軟體推薦
- H2
文檔利器-Markdown
## 1、Markdwon 文法入門級簡介
1.1、标題文法#1-#6
# H1
## H2
...
###### H6
效果如下:
H1
H2
...
H6
-
号的個數對應H1-H6标題的級别
- 注意#号後面要跟空格
- 根據文檔規範,不太提倡超過
的标題深度3級
- 然後注意,一個Markdown檔案隻能出現一個一級标題
1.2、清單
* 清單項1
* 清單項2
* 清單項3
效果如下:
- 清單項1
- 清單項2
- 清單項3
同樣也可以這樣來寫:
- 清單項1
- 清單項2
- 清單項3
+ 清單
+ 清單
效果如下
- 清單項1
- 清單項2
- 清單項3
- 清單
- 清單
1.3、引用
在一篇優秀的文檔之中,有自己精彩的表達,但是同樣不乏引用别人的好詞好句,為文章添磚加瓦。
在markdown中引用文法如下
> 後面接的是引用的内容
> 靜夜思
床前明月光,
疑是地上霜。
舉頭望明月,
低頭思故鄉。
顯示效果如下:
靜夜思
床前明月光,
疑是地上霜。
舉頭望明月,
低頭思故鄉。
1.4、重點強調
有時候在一片文檔中,需要強調一些重點的内容,可以這樣
**中間是要強調的内容,顯示的效果為加粗效果**
-- 斜體強調效果--
如:
中間是要強調的内容,顯示的效果為加粗效果,是用兩個星号包裹着
斜體
加粗斜體
删除線
1.5、連結LINK
這樣實作連結效果
百度(http://www.baidu.com)
和這樣實作連結效果
百度一下
個人覺得下面實作效果更加美觀
那麼實作的如下:
[URL說明文字](URL位址)
例如:百度一下
[百度一下](http://www.baidu.com)
1.6、單詞高亮
markdown
、
Hello world
`hahha`
注意上面是反引号
一般是這樣來突出關鍵詞。
1.7、表格
有些時候我們需求對某些資料進行格式、或者按照表格方式來顯示,這樣能夠更加清晰美觀類顯示資料就需要用到表格。
| 表頭一| 表頭二|
|---|---|
|表格資料一|表格<br>資料二|
顯示如下:注意表頭下面的格式
表頭一 | 表頭二 |
---|---|
表格資料一 | 表格資料二 |
還有一點就是,如果表格中資料比較多的話,我們需要換行顯示,可以使用
來換行顯示
表頭一 | 表頭二 |
---|---|
表格資料一 | 表格 資料二 |
表格中:号的使用,表格文字的對齊方式
如:
|左對齊、這是預設的|劇中顯示|右對齊|
|:---|:---:|---:|
|左|中|右|
左對齊、這是預設的 | 劇中顯示 | 右對齊 |
---|---|---|
左 | 中 | 右 |
良好地利用對齊方式,也是可以使顯示格式更加美觀
1.8、代碼塊
在IT行業人的部落格或者文檔中、代碼塊的出現肯定是極其常見的。
在上面我們也使用了不少。
下面是文法:
```java```:java表示該代碼塊屬于java代碼,這樣的話,就能夠實作代碼高亮顯示
Class A{
private int sid;
public void setSid(int sid){
this.sid = sid;
}
}
注意:在正文中、代碼塊前面需要加入一個空行。
1.9、圖檔
![-w50](https://www.baidu.com/img/bd_logo1.png?where=super)
代碼格式:
基礎文法:
![圖檔title](圖檔URL)
注意是以!開頭
進階用法
![圖檔說明][URL的id]
在文章最後指定URL的Id的連結位址
文法:
[URL的id]: URL位址
---
下面是關于圖檔大小、居中顯示的一些設定
居中顯示:<center></center>,但是有些編輯器可能不太支援
-w200: 表示寬度200px,在[]中書寫
可以使用css代碼來實作:
<img src="https://www.baidu.com/img/bd_logo1.png?where=super " width="80px" align="center">
width="80px":指定寬度
align="center":居中顯示
在圖檔中有幾點需要注意:由于圖檔的URL需要是網際網路可以讀取的,
是以在圖檔存取上,我們一般不存在與本地電腦中。需要存在網際網路上,推薦七牛雲、或者其他圖床網站
2、文檔規範
在書寫文檔時,我們有許多需要提倡的規範,這樣能夠時文檔更加正規、合理。
- 1、一篇文檔隻能有一個一級标題
- 2、文檔内容中不要出現太多截圖
- 3、重要的内容加粗标注
- 4、代碼使用代碼框
- 5、引用要說明引用源
3、markdown軟體推薦
- window系統:Typora
- mac系統:Mou
- 當然也有其它,适合自己的才是最好的,自己可以搜尋下載下傳
轉載于:https://www.cnblogs.com/Hunter-1/p/9307568.html