作為程序員,這份Markdown備忘單你永遠(yuǎn)需要
Markdown 是一種輕量級的標(biāo)記語言,我們可以用它來格式化純文本文檔。
GitHub上的每個倉庫都有自己的README文件,解釋了該倉庫的目的。每個項目都需要好的文檔。GitHub 的文檔是用 Markdown 編寫的。這也正是為什么需要很好地處理一些基礎(chǔ)知識。有很多元素你可以用Markdown來寫,所以我們來深入了解一下。
段落
通過寫常規(guī)文本,基本上是在寫一個段落。
標(biāo)題
有6種標(biāo)題變體。符號 "#" 的數(shù)量,以及后面的文字,表明標(biāo)題的重要性。
強(qiáng)調(diào)
修改文本是如此整潔和容易。你可以讓你的文字變成粗體、斜體、刪除線、高亮、下標(biāo)或上標(biāo)。
引用
圖片
如果你使用的是GitHub,最好的方法是直接從電腦上拖放圖片到README文件。你也可以為圖片創(chuàng)建一個引用,并通過這種方式來分配它。以下是語法。
鏈接
與圖片類似,鏈接也可以直接插入或通過創(chuàng)建一個參考??梢詣?chuàng)建內(nèi)聯(lián)和塊狀鏈接。
代碼
你可以創(chuàng)建內(nèi)聯(lián)式和全塊式的代碼片斷。還可以定義在代碼片段中使用的編程語言。所有這些都是通過使用反斜線。
列表
正如你在HTML中可以做的那樣,Markdown允許創(chuàng)建有序和無序的列表。
也可以混合這兩個列表并創(chuàng)建子列表。
還可以創(chuàng)建定義列表(術(shù)語-定義):
表格
顯示排列整齊的數(shù)據(jù)的好方法。使用**"|"** 符號來分隔列,使用 ":" 符號來對齊行內(nèi)容。
也可以通過排除外部的 "|" 符號和不使你的代碼有良好的結(jié)構(gòu)來創(chuàng)建一個 "混亂的"表格。
列表
追蹤已經(jīng)完成的任務(wù)和需要完成的任務(wù)。
腳注
想在文件的末尾描述一些東西?用腳注吧!
標(biāo)題標(biāo)識
你可以給一個標(biāo)題賦予ID,以便從你所在的地方直接跳到文件的那個部分。
你可以使用星號、連字符或下劃線(*、-、_)來創(chuàng)建一個橫線。唯一的規(guī)則是,你必須包括至少三個字符的符號。
這里,我創(chuàng)建了一個GitHub repo,大家可以用這個地址來練習(xí):
https://github.com/im-luka/markdown-cheatsheet#html
原文:https://dev.to/imluka/the-only-markdown-cheatsheet-you-will-ever-need-ccg