Sphinx+github+ReadtheDocs書寫筆記
977
2022-05-29
一、前言
由于部分語法無法展示,推薦使用Typora解鎖全套,-:https://www.typora.io/
博客推薦使用CSDN:https://www.csdn.net/
markdown數學公式大全,https://www.cnblogs.com/nickchen121/p/11746655.html
基本介紹:
Markdown是一種可以使用普通文本編輯器編寫的標記語言,通過簡單的標記語法,它可以使普通文本內容具有一定的格式。
如果一直使用word撰寫文檔,有比較大的弊病:
只能對純文本文件進行版本控制,而word是二進制格式
格式繁雜,經常需要中斷寫作來控制格式
代碼與文檔分離,給寫文檔造成更大的阻力
而假如單純的使用txt,就沒有一點格式了,用html雖然既有格式又能加入版本控制,但是需要花費較多的時間在標簽上,而且標簽占了文檔的較大百分比,不易閱讀。
所以,最終的解決方案就是?Markdown?,作為一種輕量級的標記語言,能在非常短的時間內掌握。而且不僅可以用于寫文檔,還可以寫博客、寫簡書、做一些隨手筆記。Markdown文件以.md結尾,可以導出為html和PDF(需要使用的工具支持)。
它是一種語法(個人認為是簡化版的html),但是和html不同的是,各種解析器對其會有不同的表現。比如我的IDEA Markdown插件會把分割線顯示成一條細灰線,Cmd Markdown則是顯示一條虛線。所以建議保持使用一種Markdown工具和盡量使用標準語法。
二、Markdown基本語法
2.1 標題
代碼:
# 一級標題 ## 二級標題 ### 三級標題 #### 四級標題 ##### 五級標題 ###### 最小只有六級標題
效果:
自己復制粘貼便可知曉!
2.2 加粗
代碼:
**我被加粗了**
效果:
我被加粗了
2.3 斜體
代碼:
*我傾斜了了*
效果:
我傾斜了了
2.4 高亮
代碼:
==我高亮了==
效果:
我高亮了
2.5 上標
代碼:
2^2^
效果:
22
2.6 下標
代碼:
H~2~o
效果:
H2o
2.7 代碼引用(>式)
代碼:
> hello markdown!
效果:
hello markdown!
代碼:
> hello markdown! >> hello markdown!
效果:
hello markdown!
hello markdown!
2.8 代碼引用(```式)
代碼:
# 不要復制這一句話,并且去掉下面的反斜杠,謝謝! \`\`\`python print('hello nick') \`\`\`
效果:
print('hello nick')
2.9 代碼引入(`式)
代碼:
# 不要復制這一句話,并且去掉下面的反斜杠,謝謝! \`print('hello nick')\`
效果:
`print(‘hello nick’)`
2.10 插入鏈接(鏈接顯示)
代碼:
效果:
https://www.cnblogs.com/nickchen121/p/10718112.html
2.11 插入鏈接(鏈接描述顯示)
代碼:
[nickchen博客](https://www.cnblogs.com/nickchen121/p/10718112.html "nickchen博客")
效果:
nickchen博客
2.12 插入圖片(鏈接)
代碼:

效果:
2.13 插入圖片(圖片路徑)
絕對路徑:.md文本同目錄下圖片的名字,如數據類型總結-搞笑結束.jpg?x-oss-process=style/watermark
相對路徑:圖片在電腦中的路徑地址,如\Users\nick\mac\desktop\數據類型總結-搞笑結束.jpg?x-oss-process=style/watermark
代碼:
 
2.14 有序列表
代碼:
1. one 2. two 3. three
效果:
one
two
three
2.15 無序列表
代碼:
* one * two * three
效果:
one
two
three
2.16 分割線
代碼:
---
效果:
2.17 表格而且第二行必須得有,并且第二行的冒號代表對齊格式,分別為居中;右對齊;左對齊):
name | age | sex :-:|:-|-: tony|20|男 lucy|18|女
效果:
2.18 數學公式(行內嵌)
代碼:
內嵌數學公式$\sum_{i=1}^{10}f(i)\,\,\text{thanks}$
效果:
內嵌數學公式∑ i = 1 10 f ( i ) ?? thanks \sum_{i=1}^{10}f(i)\,\,\text{thanks}∑i=110 f(i)thanks
2.19 數學公式(塊狀)
代碼:
$$ \sum_{i=1}^{10}f(i)\,\,\text{thanks} $$
效果:
∑ i = 1 10 f ( i ) ?? thanks \sum_{i=1}^{10}f(i)\,\,\text{thanks}i=1∑10 f(i)thanks
三、總結
以上所述就是Markdown的基本標簽,雖然不多,但是可以解決大部分情況。
可以用20%的標簽完成80%的效果
基礎markdown語法參考:https://www.appinn.com/markdown/
插入數學公式markdown語法參考:https://www.zybuluo.com/codeep/note/163962
Markdown 數據結構
版權聲明:本文內容由網絡用戶投稿,版權歸原作者所有,本站不擁有其著作權,亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容,請聯系我們jiasou666@gmail.com 處理,核實后本網站將在24小時內刪除侵權內容。