做爲一個半路出家,入行快四年的程序猿,寫文檔一直是一件讓我很頭疼的事。使用Word時候,須要考慮諸如標題、字號、格式、縮進等等一系列的東西,而要能熟練的使用這些,我以爲不是三兩天的時間能夠搞定的。由於以上緣由(主要是由於懶),一直很抵觸寫文檔這件事。html
前段時間由於工做須要,到了不起不寫文檔的時候了。一想到要將項目相關的文檔全都翻譯成中文,寫成文檔,當時以爲天都要塌了。所幸山重水複疑無路,柳暗花明又一村。在翻譯文檔的時候,發現人家項目的說明文檔全是「.md」後綴的。這個後綴的文檔,以前見過不少,知道是Markdown文檔。既然別人的官方文檔是用Markdown寫的,爲了儘量的保證原汁原味,那咱也用「.md」寫吧。python
如下是我的在使用Markdown時的一些總結。我使用的編輯器是微軟的VScode。在這裏不得不誇一句,「VScode真好用!!!」。ios
使用vscode寫md文檔時,我主要用到了兩個插件:Markdown Preview Enhanced 和 Markdown PDF。Markdown Preview Enhanced是用來預覽文件的;Markdown PDF是用來將寫好的文檔轉換成其它格式,支持轉化的文件格式有:pdf、html、png和jpeg四種格式。markdown
Markdown是一種輕量級的標記語言,語法十分簡單,經常使用的符號也不超過十個。因此Markdown的學習成本不會很高,並且一旦熟悉了語法,那將是一勞永逸的事。編輯器
使用Markdown時,你只須要專一於你的文字內容而不須要分出過多的精力來組織文檔的排版;並且能夠輕鬆導出爲PDF或HTML。學習
Markdown的哲學在於「Markdown is intended to be as easy-to-read and easy-to-write as is feasible」。插件
經常使用的語法以下表:翻譯
輸出效果 | 寫法 |
---|---|
粗體 | **text** |
斜體 | *text* |
連接 | [title](http://) |
大段引用 | ``` content``` |
小段引用 | > content |
一級標題 | # head |
二級標題 | ## head |
... | ... |
六級標題 | ###### head |
當須要換行時,在行尾輸入兩個空格而後回車code
只需在兩段文字之間空一行便可htm
使用「*」,與文字間隔一個空格。
Markdown的表格比較麻煩,寫法以下:
|tables|col1|col2| |---|:---:|---:| |col1|col2|col3| |content|hello world|Markdown|
顯示以下:
tables | col1 | col2 |
---|---|---|
col1 | col2 | col3 |
content | hello world | Markdown |
代碼框中可使用tab
進行縮進。
print()
#include <iostream> int main(int argc,char* argv[]) { std::cout<<"hello world"<<std::endl; return 0; }
分割線的話,使用***
就好。
上邊是分割線。