惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

SecWiki News
SecWiki News
I
InfoQ
The Cloudflare Blog
人人都是产品经理
人人都是产品经理
博客园 - Franky
T
Tailwind CSS Blog
让小产品的独立变现更简单 - ezindie.com
让小产品的独立变现更简单 - ezindie.com
量子位
博客园_首页
罗磊的独立博客
V
V2EX
李成银的技术随笔
大猫的无限游戏
大猫的无限游戏
钛媒体:引领未来商业与生活新知
钛媒体:引领未来商业与生活新知
T
True Tiger Recordings
Vercel News
Vercel News
Cyberwarzone
Cyberwarzone
Cisco Talos Blog
Cisco Talos Blog
F
Fox-IT International blog
D
Darknet – Hacking Tools, Hacker News & Cyber Security
M
Microsoft Research Blog - Microsoft Research
Know Your Adversary
Know Your Adversary
爱范儿
爱范儿
The Register - Security
The Register - Security
G
Google Developers Blog
The Hacker News
The Hacker News
Malwarebytes
Malwarebytes
S
Securelist
博客园 - 三生石上(FineUI控件)
Jina AI
Jina AI
T
Threat Research - Cisco Blogs
T
The Exploit Database - CXSecurity.com
S
SegmentFault 最新的问题
博客园 - 叶小钗
F
Fortinet All Blogs
Apple Machine Learning Research
Apple Machine Learning Research
宝玉的分享
宝玉的分享
博客园 - 聂微东
T
Threatpost
博客园 - 【当耐特】
D
Docker
P
Privacy & Cybersecurity Law Blog
www.infosecurity-magazine.com
www.infosecurity-magazine.com
G
GRAHAM CLULEY
V
Visual Studio Blog
C
Cisco Blogs
IT之家
IT之家
S
Security Archives - TechRepublic
Latest news
Latest news
阮一峰的网络日志
阮一峰的网络日志

jdhao's digital space

Manage uv.lock file with Renovate Set up Python Provider for Neovim Ripgrep Config to Search Hidden Files Pre-commit Setup for Your Project I read the nvim v0.12 release note so you don't have to Return Different Values for Each Call of A Mock Migrate Python Project from Pip to Uv 德语常用不规则动词 葱油鸡腿制作 Check Trailing White Spaces in Your Project 菜谱:茄子肉丁 object vs nested type in data mapping in Elasticsearch Node, Index, Shard in Elasticsearch Logging setup for Pytest Select fields in Elasticsearch: _source, fields and stored_fields 中式葱花饼制作 菜谱: 凉拌苤蓝(卜留克/kohlrabi) 我也有高考 PTSD Garmin Course Syncing Not Working? Prevent Accidental Index Delete in Elasticsearch How to Import GPX File into Garmin Watch Python system PATH issues When We Use Pytest 菜谱:泰式打抛牛肉 菜谱:烤箱羊肉串 How to Filter Warnings in Python/pytest 家常烤箱烤鸡腿 Comparison between Several Desktop Speakers How to Use LuaRocks Package in Neovim Macbook 外接显示器 家常萝卜炖羊排 Run the Job Immediately after Starting Scheduler in Python APScheduler Retry for Google Cloud Client 菜谱:土豆金枪鱼沙拉 菜谱:椰香咖喱鸡 凉拌绿豆宽粉制作 Make Python logging Work in GCP Liveness and Readiness Check in Kubernetes Notes on Using GCP Logging 西班牙土豆饼制作 Elasticsearch Version Conflict Error How to Use the Elasticsearch task API Speed up document indexing in Elasticsearch via bulk indexing Index refresh issue in Elasticsearch Google Cloud Storage Usage 家常煎羊排制作 凉拌茄子制作 Configure Python logging with dictConfig Debugging Wezterm Issues Black Formatter Setup for Python Project Git line ending config Garmin Forerunner 965 Essential Tips and Setups How to Download Files from Google Cloud Storage in the Databricks Workspace Notebook Databricks Cli Usage Working with Databricks Workspace Files 手抓羊肉饭制作 Databricks Init Scripts Using Virutal Environment in Python with venv File Systems in Databricks LATERAL VIEW EXPLODE in Spark 菜谱:麻婆豆腐 在德国做台湾卤肉饭 FastAPI testing and OpenAPI doc generation Change Timezone in Databricks Spark How to Profile Your Python Script/Module 菜谱:茄子肉沫 Migrating from Packer.nvim to Lazy.nvim How to Extract PDF file on macOS How to Deploy Fastapi Application with Docker Nerdfont Icon Missing after Wezterm Upgrade Pylsp setup for Neovim in 2023 How to Parse Query Param With Multiple Values in FastAPI 菜谱:土豆胡萝卜烧牛肉 Zsh Startup Files in macOS PATH Variable Changed inside Tmux on macOS? Work with JSON File in Neovim Running/importing Python code/module in Databricks Agile and Scrum 菜谱:凉拌牛肉 Awesome Command Line Tools Written in Rust How to get or set Databricks spark configuration Set Up German Version macOS Add A Custom Search Engine for Vimium 中国大陆小米手机如何使用 Google Pay 春节回乡记 滇西之行 2023 贵阳行 2023 程序员海外工作---语言篇 2023 长沙行 2023 西安行 德国工签申请指南 2022 年博客回顾 感染 omicron 记录 How to Override Default Options in Neovim Variadic Arguments in Lua How to Enable Method Autocompletion for OpenCV How to Read Local CSV File to Table in MySQL I read the nvim v0.8 release note so you do not have to Creating A Trigger in PostgreSQL Cost of Living in Shenzhen You Do Not Need a Plugin for This Feature
写给初学者的 Markdown 教程
2018-09-21 · via jdhao's digital space

这是一篇帮助初学者快速入门 Markdown 的文章,看完此篇,你应该就可以使用 Markdown 写出格式规范的文章了。

Markdown 是一种可标记语言,通过简单的标记,可以将纯文本内容转为内容丰富的 HTML 网页,实现字体加粗,链接,插入图片等等纯文本无法实现的功能。

Markdown 类似编程语言,需要先编写,然后通过渲染器把 Markdown 源文件转为内容丰富 的 HTML 网页(类似于编程语言的编译器,把一种语言翻译为另外一种语言)。

Markdown 优点#

采用 Markdown 生成的文档,格式规范,清晰明了,避免了纯文本文件无法对文本格式进 行控制的尴尬,是书写技术文档的最佳选择之一。同时,Markdown 又不像网页那样复杂, 仅仅使用简单的语法,就能生成丰富的内容,这也是 Markdown 流行的原因。

Markdown 具体语法#

本部分介绍常用的 Markdown 语法,由于 Markdown 类似编程语言,因此对书写格式有一 定要求,符合要求才能生成想要的结果,书写时候一定要遵循规范。

标题(heading)#

Markdown 中的标题采用 # 来标志,# 后面跟具体的标题文本。# 的个数代表标题 级别:1 个 # 代表一级标题,2 个 # 代表二级标题,以此类推。

注意点#

  • # 与标题的文本之间,需要留一个空格,否则可能无法正常渲染为标题样式
  • 标题级别不要太多,五六级标题与正文文本字体大小区别已经不大,因此意义也不大

效果展示与源代码#

源代码:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

生成的标题效果为:

markdown_heading.png

列表#

Markdown 中的列表,分为有序列表以及无序列表两种。

  • 对于有序列表,使用数字开头,后面跟 .(英文的句号),空格,后面写上该步骤内容。
  • 对于无序列表,使用 + 或者 - 开头,空格,后面写具体内容。

你也可以创建多级嵌套列表,在某一级别下另起一行,缩进四个空格开始更低级别。

注意点#

  • 列表项前面需要空一行,否则某些 Markdown 渲染器无法正常识别列表
  • 列表标志后面需空格

效果展示与源代码#

源代码:

1. 有序列表,这是步骤一
    1. 步骤 1.1
        1. 步骤 1.1.1
        2. 步骤 1.1.2
        3. 步骤 1.1.3
    2. 步骤 1.2
    3. 步骤 1.3
2. 有序列表,这是步骤二
    1. 步骤 2.1
    2. 步骤 2.2
3. 有序列表,这是步骤三

+ 车
    + 汽车
        + BMW
        + BYD
    + 火车
        + 普通列车
        + 动车
        + 高铁
    + 自行车
+ 动物
    + 猴子
    + 骆驼
    + 大象
+ 人
    + 白人
    + 黑人
        + 非洲黑人
        + 美洲黑人
        + 亚洲黑人
    + 黄人

生成的列表效果如下图:

markdown_list.png

强调与着重表示#

要使用斜体,可以使用一对 * 或者 _包围要斜体的文字;要加粗文字,使用两对 * 或者 _ 包围文字。

如何既斜体又加粗文字?*_ 交替使用即可,像这样 ,或者 这样

以上文字源代码为:

要使用*斜体*,可以使用一对 `*` 或者 `_`包围要斜体的文字;要**加粗文字**,使用两对 `*` 或者 `_` 包围文字。

如何既斜体又加粗文字?`*` 与 `_` 交替使用即可,*__像这样__* ,或者 _**这样**_ 。

注意点#

  • 使用 _ 进行斜体或者着重表示,可能需要和周围文字之间加上空格,否则无法正常渲 染,建议使用 *

链接#

可以给文字加上链接,链接的格式为 [](),方括号内填写希望显示的文字,圆括号内填 写该文字具体链接的网页地址。

例如,我们不可以访问谷歌YouTube。直接书写网页地址也可以,用 <> 包含网页, 像这样,https://www.google.com/

可以给文字加上链接,链接的格式为 `[]()`,方括号内填写希望显示的文字,圆括号内填写该文字具体链接的网页地址。

例如,我们不可以访问[谷歌](https://www.google.com/)和 [YouTube](https://www.youtube.com)。直接书写网页地址也可以,
用 `<>` 包含网页,像这样,<https://www.google.com/>。

代码块与代码段#

Markdown 中可以写 inline code 以及 code block,inline code 使用一对 ` ( backtick 键)包含,sell = np.sin(time)。code block 使用三个 ` 开始与结 束。

import matplotlib
matplotlib.use('agg')
import matplotlib.pyplot as plt
import numpy as np

print("hello")
for i in range(10):

    print(i)

x = np.linspace(0, 4, 100)
y = np.sin(x)
fig, ax = plt.subplots()

ax.plot(x, y)
plt.savefig('test.png')

上述代码块源代码为

```
import matplotlib
matplotlib.use('agg')
import matplotlib.pyplot as plt
import numpy as np

print("hello")
for i in range(10):

    print(i)

x = np.linspace(0, 4, 100)
y = np.sin(x)
fig, ax = plt.subplots()

ax.plot(x, y)
plt.savefig('test.png')
```

图片#

可以在 Markdown 中使用图片,格式为 ![Image_caption](Image_link)。有两种方式 来引用图片:

  1. 本地图片:直接写上图片绝对路径或者相对当前 Markdown 文件的相对路径
  2. 网络图片:直接写上图片链接即可
这是一张网络图片

以上图片对应的源代码如下:

![这是一张网络图片](https://assets-cdn.github.com/images/modules/logos_page/Octocat.png)

注意点#

如果图片的链接为本地路径,Markdown 文件移动到其它地方,或者分享给他人以后,图片 将不能显示。可以使用一些图床1来存放图片,保 证在哪里都能显示图片。或者,尽量不在 Markdown 里使用图片。

表格#

Markdown 中也可以书写简单的表格:

姓名数学语文
张三12
李四34

生成上述表格的源代码为:

|姓名|数学|语文|
|---|---|---|
|张三| 1| 2 |
|李四| 3| 4 |

自己手写一个表格比较麻烦和枯燥,可以利用在线的工具,生成 Markdown 格式的表格, 一个不错的网站是 TableGenerator.

任务列表#

某些种类的 Markdown 还支持任务列表语法,例如:

  • 吃饭
  • [] 睡觉
  • 打怪兽
  • [] 写作业
  • [] 看电影

生成上述任务列表的源代码如下:

- [x] 吃饭
- [ ] 睡觉
- [x] 打怪兽
- [ ] 写作业
- [ ] 看电影

[] 中加上 x 表示某个任务已经完成,否则表示该任务进行中。

Markdown 源文件编辑与预览#

推荐几款编辑与预览的编辑器,VNote,Sublime Text 与 Visual Stuido Code

Vnote#

Vnote 是国人开发的 Markdown 笔记软件,专为 Markdown 设计,可以方便编写 Markdown 文件,进行预览,对文件进行管理等。

Visual Stuido Code#

安装 Visual Studio Code,VScode 原生支持 Markdown 文件预览,无需安装插件,按 Ctrl+K,再按 V,会在当前编辑窗口的右边打开文件 预览窗口,可以实时查看生成的 HTML 文件效果。更多指导,请查看 官方文档

Sublime Text#

安装 Sublime Text,并且安装插件 Markdown Preview

写好 Markdown 以后,直接使用快捷键 Ctrl+Shift+M 打开浏览器预览生成的 HTML 网页效 果。

参考资料#

  • Markdown cheatsheet:https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links
  • Markdown 官方文档:https://daringfireball.net/projects/markdown/

  1. 所谓“图床”,简单来说,就是存储图片的网络空间,这样不管身在何处,只要有网络,就可以看到图片。 ↩︎