引言:我要是能想出來這東西,我都找到
女朋友
了。反正非常有用就行了!Readme.md文檔
和日常博客
、日報筆記
之類的寫的賊方便.方便就方便在它是文本標記語言,整篇文檔下來不需要鼠標即可進行(那是不可能的,除非你不復制粘貼不做其他小動作)。
下面呢展示一些Markdown的一些經常用到的語法。其他的請自行學習,獨秀同志不要鬧我們馬上開課啦(這裏該有一個騷騷的表情包可惜我沒有QAQ)。
1. 標題
標題標記是最基本的標記,因爲我們基本上做什麼都要先起標題。
該標記由#構成。標記由大到小對應#號由多變少一共六個擋位,自由變檔無頓挫感,別克***。
咳咳。上面那個標題就是一個#構成的。
再有一點強調就是一定要注意很多標題和文字中間需要加空格,如果沒有出來效果文檔就增加空格試一下,切記不要拍桌子
,它會疼
2. 文字加粗
不說啦不說啦 這個很簡單我變粗了就好啦。(星星+你要寫的+星星)
就像這樣**我細下來拉**
3. 文本替換超鏈
比如你想要關注我你就需要點這裏。哇,介麼神奇。只需要
[文本](超鏈)
即可輕鬆擁有,你還在等什麼,趕快關注我呀大爺們/(ㄒoㄒ)/~~
關注後再給你看一個大寶貝[文本](超鏈 "超鏈標題")
這樣就可以實現鼠標放置出現超鏈標題拉
4. 代碼高亮
如果不想讓自己的代碼粘貼上來
平平無奇
,那麼就一定要記住這個標記(用一下標記吧,直接粘上來的代碼眼睛直接都花了)。
支持大部分語言的代碼高亮,只需要將java換成對應語言的小寫名稱即可,當然也可以直接是文檔換成text就好啦
##比如
public static void main(String[] args){
System.out.println("我是隻居");
}
5. 添加圖片
比如我加一個派大星。
![派大星](https://img-blog.csdnimg.cn/20200305193243214.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlMTE1NDkxMDk0MQ==,size_16,color_FFFFFF,t_70 “鼠標懸停圖片標題”)
當然這砸夠,我要是想讓圖片是個超鏈也可以,我就套娃,套娃就行啦,我外面再套一個超鏈的。欸嘿嘿,真香!套不上去,他媽的csdn老打斷我。超鏈沒放進來都開始下圖片
[![圖片說明](圖片地址 圖片標題)](超鏈地址 "超鏈標題") 這裏會優先顯示圖片標題
6. 列表
列表也是我們經常用的一個拉,比如list。咳咳ArrayList和LinkedList的區別。咳咳就是類似於
<ol>
,<ul>
標籤
1. 有序列表
即1.
數字小數點和空格組合。一定記住空格
2. 無序列表
無需列表可使用的標記有三個, -
*
+
,當它們爲二級列表時,加一個縮進前面的點將爲空心圓,最多三層到實心方塊結束
- 減號
- 繼續減號
- 繼續
- 星號
- 繼續星號
- 加號
- 繼續加號
7. 重點文字高亮標記
``,ESC下面1左面哪個波浪線在英文下就是這個反引號號,兩個這個可以將圈中文字高亮,並且
所有Markdown標記均!失!效!
,記好了偶
8. 擴展:項目結構編寫
害,想起來這個我都能想到
bilibili
,我就聯想到github。我都又想起來GO語言了。真神奇(這裏補一個騷圖)
你可以通過這個來描述項目結構,可以讓觀看者更直觀的瞭解項目各部分的功能。也可以用這個展示工程架構。
我的項目
├── auth -- 授權服務提供
├── common -- 常用工具封裝包
├── gateway -- 網關
├── ops -- 運維中心
├ ├── monitor -- 監控模塊
├── service -- 業務模塊
├ ├── system -- 系統模塊
├ └── user -- 用戶模塊
├── service-api -- 業務模塊api封裝
├ ├── dict-api -- 字典api
├ ├── system-api -- 系統api
└── └── user-api -- 用戶api
9. 我都忘了我寫引言的標記了
>
空格不能丟奧,不然桌子該疼了
10. 轉義
因爲Markdown把好多符號都徵用站崗去了了,那我們要用咋辦捏,人家也想要動一動呢。那就轉義好啦。暫時讓它粗來幫你一下下
Markdown 使用反斜槓轉義特殊字符
這些是支持轉義的
\ 反斜線
` 反引號
* 星號
_ 下劃線
{} 花括號
[] 方括號
() 小括號
# 井字號
+ 加號
- 減號
. 英文句點
! 感嘆號
結束語
你以爲到這裏就完了嗎,這只是markdown的基本功能嗷。你才光會寫呢。markdown還能畫。你問我能畫啥?
表格
,數學公式
,流程圖
,甘特圖
,時序圖
它都能完成。我的天哪!瞬間被滿足了呢!
咳咳,我的陳述完畢。法官大人,我真的只是在學習呀。