简书 Markdown 语法详解

2023-12-01 21:32
文章标签 详解 语法 markdown 简书

本文主要是介绍简书 Markdown 语法详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

注: 文章摘自 白老师课堂 - 简书

一、区块标记

区块标记:是指内容独占一块,需前后换行,不和其他标记共处一行的标记

1. 段落

段落:即是一段连续的文字,可包含 * 、空格、换行、tab 等字符。两个段落之间使用空行分隔

示例代码

第一自然段第二自然段

效果

第一自然段

第二自然段

注意:换行不是分段的标识,空行才是

2. 标题

标题:代表了文章中主题的层次,比如:文章标题使用一级标题,回目名称使用二级标题,小节使用三级标题,依次类推。主题的层次代表了文章的大纲

语法:Markdown 中使用连续 n(1-6) 个 "#" 分别表示第 n 级标题, "#" 和后续内容之间应放置一个空格

示例代码

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

效果

一级标题

二级标题

三级标题

四级标题
五级标题
六级标题
3. 列表

列表:就是一组相关信息的集合

  • 有序列表

语法:使用 "(数字)" 和 "." 作为项目符号,项目符号和正式列表项目之间有一个空格

示例代码

1. 步骤一
2. 步骤二
3. 步骤三

效果

  1. 步骤一
  2. 步骤二
  3. 步骤三
  • 无序列表*

语法:使用 "+" 作为项目符号,项目符号和正式列表项目之间有一个空格

示例代码

+ 一级目录+ 二级目录+ 三级目录+ 四级目录
+ 一级目录+ 二级目录+ 二级目录+ 三级目录

效果

  • 一级目录

    • 二级目录
      • 三级目录
        • 四级目录
  • 一级目录

    • 二级目录
    • 二级目录
      • 三级目录

注意

  • 无序列表的符号可使用 *,+,- 效果是相同的
  • 每一层级目录 (第一层级除外) 前面应相对于上一层级添加一个 tab 或两个空格, 以便区分等级
4. 分割线

语法:至少使用 3 个连续的 * 即可得到一个分割线

示例代码

***

效果


5. 引用

语法:在行头加上 ">" 即可, ">" 和后续内容之间有一个空格

示例代码

> 引用

效果

引用

注意

  • 可以在每行之前加 ">" ,也可以在段落之前加 1 个 ">"
  • 引用内部可以使用其他 Markdown 标记

二、行内标记

行内标记和其他标记共处一行

1. 强调文字
  • 斜体

语法:内容前后各1个 "*"或"_"

示例代码

*斜体*
_斜体_

效果

斜体
斜体

  • 粗体

语法:内容前后各2个 "*"或"_"

示例代码

**粗体**
__粗体__

效果

粗体
粗体

  • 删除文字

语法:内容前后各2个 "~"

示例代码

~~删除~~

效果

删除

  • 粗斜体

语法:内容前后各2个 "" 和1个"_" 或 1个 ""和2个"_" (左右要对称)

示例代码

_**粗斜体**_
*__粗斜体__*
**_粗斜体_**
__*粗斜体*__

效果

粗斜体
粗斜体
粗斜体
粗斜体

2. 图片
  • 行内图片

图片和图片地址写在一起

语法: [图片上传失败...(image-b2fafa-1534418374184)]

示例代码

![简书 LOGO](https://upload-images.jianshu.io/upload_images/4804567-a1a23be9218ff8c4.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

效果

4804567-a1a23be9218ff8c4.png
简书 LOGO

注意

  • 在简书中,图片可以直接拖到编辑区,会自动上传图片并生成图片地址; 也可以右键 (Ctrl + V) 直接粘贴
  • "[]" 方括号里的内容可以不写
  • 引用图片

图片和图片地址分开书写

语法:
![图片标题][图片 id]
(空行)
[图片 id]:图片 url

![简书 LOGO][jianshu][jianshu]:https://upload-images.jianshu.io/upload_images/4804567-a1a23be9218ff8c4.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240

效果

4804567-a1a23be9218ff8c4.png
简书 LOGO

注意

  • 引用图片的 id 在文章中必须唯一
  • 名称和路径之间至少空一行
  • 图片名称 (第一对"[]"内容) 可以不写
  • 链接 id 可使用字母、数字、空格和下划线等,不区分大小写
3. 链接
  • 行内链接

链接和地址写在一起

语法:[链接名称](链接地址 url "链接title")

示例代码

[小贤笔记](https://www.jianshu.com/u/195a91a868f5)

效果

小贤笔记

  • 引用链接

链接和地址分开书写

语法:
[链接名称][链接id]
(空行)
[链接id]:链接 url 地址 "链接 title"

示例代码

[小贤笔记][xxbj][xxbj](https://www.jianshu.com/u/195a91a868f5)

效果

小贤笔记

注意

  • 链接 id 可使用字母、数字、空格和下划线等,不区分大小写
  • 名称和路径之间至少空一行
  • 自动链接

一种简明的链接书写方式

语法:<链接地址>

示例代码

<https://www.jianshu.com/u/195a91a868f5>

效果

https://www.jianshu.com/u/195a91a868f5

4. 脚注

为名词提供注释,注释将显示在文章末尾

语法:
待解释文字[^脚注 id]
[^脚注 id]:注释内容

示例代码

Hello World[^hello]
[^hello]:你好, 世界

效果

Hello World[1]
(第二行的内容在文章最底部)

注意事项

  • 脚注 id 必须唯一
  • 无论脚注 id 如何起名,显示时一律标为数字,并且按出现顺序排列
  • 翻译的内容会自动跳到文章末尾

三、代码块

行内代码块

语法:使用两个 "`"(esc 下面的那个键) 将代码包含起来

示例代码

`Hello World`

效果

Hello World

多行代码块

语法:只需要每行都缩进 4 个空格即可,或者使用```框起来

  • 方法1: 每前面增加两个 tab 或 4个空格

示例代码

    function() {alert("Hello, world")}

效果

    function() {alert("Hello, world")}
  • 方法2: 代码上下用 ```(esc 下面的键) 框起来

示例代码

... // ← esc 下面的键, 由于显示问题, 这里用 "." 代替
function() {alert("Hello, world")
}
... // ← esc 下面的键, 由于显示问题, 这里用 "." 代替

注意

  • 在代码区块内部,Markdown 标记失效,比如:+ 就是 + ,不被解释为特殊标记

四、表格

语法:

  • 第一行为表头,第二行分隔表头和主体部分,第三行开始每一行为一个表格行
  • 列于列之间用管道符 "|" 隔开, 表格每一行两边的管道符可省略
  • 第二行还可以为不同的列指定对齐方向, 默认为左对齐;在 "-" 左边加上 ":" 就是左对齐;在 "-" 右边加上 ":" 就是右对齐;在 "-" 两边都加上 ":" 就是居中对齐

示例代码

|姓名|年龄|性别|身高(cm)|
|-|:-|:-:|-:|
|张三|22|男|180|
|李四|18|女|165|

效果

姓名年龄性别身高(cm)
张三22180
李四18165

五、其他问题

1. Markdown 与 HTML 的关系
  • HTML 是一种发布的格式,Markdown 是一种书写的格式
  • Markdown 的格式语法只涵盖纯文本可以涵盖的范围
  • 在 Markdown 中可直接使用 HTML 标签,但需要注意
    • 对于 HTML 区块元素――如 div、table、pre、p 等标签,必须在前后加上空行与其它内容区隔开,还要求它们的开始标签与结尾标签不能用制表符(tab)或空格来缩进
    • HTML 的行内标签——如 span、cite、del 可以在 Markdown 的段落、列表或是标题里随意使用
    • 在 HTML 的区块标签中的 Markdown 标签是没有效果的
2. 特殊字符的自动转换
  • 在 HTML 文件中,有两个字符需要特殊处理: < 和 &,必须使用转义字符:& lt ; 和 & amp
  • Markdown 中,你可以自由的书写 < 和 &,编辑器会智能的进行判断:当这些符号用于 HTML 标签中,他们将保留原型;当他们单独使用时,将会转换为字符实体
  • 在代码块中,它们将统统被转换为字符实体,即原样显示
3. Markdown 中的转义字符

Markdown 中,如需显示有特定意义的符号,如:*,# 等,可使用 反斜杠 \ 进行转义。可对如下字符进行转义:

*
`
*
_
{}
()
#
+
-
.
!  

六、简书尚不支持的标记和不足

  • 用于生成目录索引的 [TOC]
  • 用于说明文章标签的 tags
  • 定义列表和待办事宜 Todo 列表
  • 数学公式
  • 各种图形:流程图、时序图、甘特图
  • 其他技术,如:{mermaid}
  • 区块代码中不显示行号

  1. 你好, 世界 ↩

这篇关于简书 Markdown 语法详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/442759

相关文章

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

OpenHarmony鸿蒙开发( Beta5.0)无感配网详解

1、简介 无感配网是指在设备联网过程中无需输入热点相关账号信息,即可快速实现设备配网,是一种兼顾高效性、可靠性和安全性的配网方式。 2、配网原理 2.1 通信原理 手机和智能设备之间的信息传递,利用特有的NAN协议实现。利用手机和智能设备之间的WiFi 感知订阅、发布能力,实现了数字管家应用和设备之间的发现。在完成设备间的认证和响应后,即可发送相关配网数据。同时还支持与常规Sof

6.1.数据结构-c/c++堆详解下篇(堆排序,TopK问题)

上篇:6.1.数据结构-c/c++模拟实现堆上篇(向下,上调整算法,建堆,增删数据)-CSDN博客 本章重点 1.使用堆来完成堆排序 2.使用堆解决TopK问题 目录 一.堆排序 1.1 思路 1.2 代码 1.3 简单测试 二.TopK问题 2.1 思路(求最小): 2.2 C语言代码(手写堆) 2.3 C++代码(使用优先级队列 priority_queue)

K8S(Kubernetes)开源的容器编排平台安装步骤详解

K8S(Kubernetes)是一个开源的容器编排平台,用于自动化部署、扩展和管理容器化应用程序。以下是K8S容器编排平台的安装步骤、使用方式及特点的概述: 安装步骤: 安装Docker:K8S需要基于Docker来运行容器化应用程序。首先要在所有节点上安装Docker引擎。 安装Kubernetes Master:在集群中选择一台主机作为Master节点,安装K8S的控制平面组件,如AP

嵌入式Openharmony系统构建与启动详解

大家好,今天主要给大家分享一下,如何构建Openharmony子系统以及系统的启动过程分解。 第一:OpenHarmony系统构建      首先熟悉一下,构建系统是一种自动化处理工具的集合,通过将源代码文件进行一系列处理,最终生成和用户可以使用的目标文件。这里的目标文件包括静态链接库文件、动态链接库文件、可执行文件、脚本文件、配置文件等。      我们在编写hellowor

LabVIEW FIFO详解

在LabVIEW的FPGA开发中,FIFO(先入先出队列)是常用的数据传输机制。通过配置FIFO的属性,工程师可以在FPGA和主机之间,或不同FPGA VIs之间进行高效的数据传输。根据具体需求,FIFO有多种类型与实现方式,包括目标范围内FIFO(Target-Scoped)、DMA FIFO以及点对点流(Peer-to-Peer)。 FIFO类型 **目标范围FIFO(Target-Sc

019、JOptionPane类的常用静态方法详解

目录 JOptionPane类的常用静态方法详解 1. showInputDialog()方法 1.1基本用法 1.2带有默认值的输入框 1.3带有选项的输入对话框 1.4自定义图标的输入对话框 2. showConfirmDialog()方法 2.1基本用法 2.2自定义按钮和图标 2.3带有自定义组件的确认对话框 3. showMessageDialog()方法 3.1

脏页的标记方式详解

脏页的标记方式 一、引言 在数据库系统中,脏页是指那些被修改过但还未写入磁盘的数据页。为了有效地管理这些脏页并确保数据的一致性,数据库需要对脏页进行标记。了解脏页的标记方式对于理解数据库的内部工作机制和优化性能至关重要。 二、脏页产生的过程 当数据库中的数据被修改时,这些修改首先会在内存中的缓冲池(Buffer Pool)中进行。例如,执行一条 UPDATE 语句修改了某一行数据,对应的缓

Prompt - 将图片的表格转换成Markdown

Prompt - 将图片的表格转换成Markdown 0. 引言1. 提示词2. 原始版本 0. 引言 最近尝试将图片中的表格转换成Markdown格式,需要不断条件和优化提示词。记录一下调整好的提示词,以后在继续优化迭代。 1. 提示词 英文版本: You are an AI assistant tasked with extracting the content of

OmniGlue论文详解(特征匹配)

OmniGlue论文详解(特征匹配) 摘要1. 引言2. 相关工作2.1. 广义局部特征匹配2.2. 稀疏可学习匹配2.3. 半稠密可学习匹配2.4. 与其他图像表示匹配 3. OmniGlue3.1. 模型概述3.2. OmniGlue 细节3.2.1. 特征提取3.2.2. 利用DINOv2构建图形。3.2.3. 信息传播与新的指导3.2.4. 匹配层和损失函数3.2.5. 与Super