简书 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/442760

相关文章

spring中的ImportSelector接口示例详解

《spring中的ImportSelector接口示例详解》Spring的ImportSelector接口用于动态选择配置类,实现条件化和模块化配置,关键方法selectImports根据注解信息返回... 目录一、核心作用二、关键方法三、扩展功能四、使用示例五、工作原理六、应用场景七、自定义实现Impor

一文深入详解Python的secrets模块

《一文深入详解Python的secrets模块》在构建涉及用户身份认证、权限管理、加密通信等系统时,开发者最不能忽视的一个问题就是“安全性”,Python在3.6版本中引入了专门面向安全用途的secr... 目录引言一、背景与动机:为什么需要 secrets 模块?二、secrets 模块的核心功能1. 基

一文详解MySQL如何设置自动备份任务

《一文详解MySQL如何设置自动备份任务》设置自动备份任务可以确保你的数据库定期备份,防止数据丢失,下面我们就来详细介绍一下如何使用Bash脚本和Cron任务在Linux系统上设置MySQL数据库的自... 目录1. 编写备份脚本1.1 创建并编辑备份脚本1.2 给予脚本执行权限2. 设置 Cron 任务2

一文详解如何在idea中快速搭建一个Spring Boot项目

《一文详解如何在idea中快速搭建一个SpringBoot项目》IntelliJIDEA作为Java开发者的‌首选IDE‌,深度集成SpringBoot支持,可一键生成项目骨架、智能配置依赖,这篇文... 目录前言1、创建项目名称2、勾选需要的依赖3、在setting中检查maven4、编写数据源5、开启热

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,:本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安

HTML5 搜索框Search Box详解

《HTML5搜索框SearchBox详解》HTML5的搜索框是一个强大的工具,能够有效提升用户体验,通过结合自动补全功能和适当的样式,可以创建出既美观又实用的搜索界面,这篇文章给大家介绍HTML5... html5 搜索框(Search Box)详解搜索框是一个用于输入查询内容的控件,通常用于网站或应用程

Python中使用uv创建环境及原理举例详解

《Python中使用uv创建环境及原理举例详解》uv是Astral团队开发的高性能Python工具,整合包管理、虚拟环境、Python版本控制等功能,:本文主要介绍Python中使用uv创建环境及... 目录一、uv工具简介核心特点:二、安装uv1. 通过pip安装2. 通过脚本安装验证安装:配置镜像源(可

C++ 函数 strftime 和时间格式示例详解

《C++函数strftime和时间格式示例详解》strftime是C/C++标准库中用于格式化日期和时间的函数,定义在ctime头文件中,它将tm结构体中的时间信息转换为指定格式的字符串,是处理... 目录C++ 函数 strftipythonme 详解一、函数原型二、功能描述三、格式字符串说明四、返回值五

LiteFlow轻量级工作流引擎使用示例详解

《LiteFlow轻量级工作流引擎使用示例详解》:本文主要介绍LiteFlow是一个灵活、简洁且轻量的工作流引擎,适合用于中小型项目和微服务架构中的流程编排,本文给大家介绍LiteFlow轻量级工... 目录1. LiteFlow 主要特点2. 工作流定义方式3. LiteFlow 流程示例4. LiteF

CSS3中的字体及相关属性详解

《CSS3中的字体及相关属性详解》:本文主要介绍了CSS3中的字体及相关属性,详细内容请阅读本文,希望能对你有所帮助... 字体网页字体的三个来源:用户机器上安装的字体,放心使用。保存在第三方网站上的字体,例如Typekit和Google,可以link标签链接到你的页面上。保存在你自己Web服务器上的字