Markdown基础语法，一篇就够了

最新推荐文章于 2024-09-18 09:09:43 发布
最新推荐文章于 2024-09-18 09:09:43 发布
阅读量1.8k 收藏 31
点赞数 6
分类专栏： 开发工具使用总结 项目工程协作 文章标签： markdown
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/smilehappiness/article/details/105067651
版权

文章目录

前言

这阵子，项目需要写接口文档，写博客也经常使用markdown语法，这次使用markdown编写接口文档，把使用心得做一下总结。人呢不能太懒惰，有时候总是眼高手低，感觉自己很熟悉，真正用起来不一定得心应手。以后还是得多学习，多总结，这样才能充实自己。

markdown文件基础语法

1.markdown介绍

  • Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。
  • Markdown具有一系列衍生版本，用于扩展Markdown的功能（如表格、脚注、内嵌HTML等等），这些功能原初的Markdown尚不具备，它们能让Markdown转换成更多的格式，例如LaTeX，Docbook。Markdown增强版中比较有名的有Markdown Extra、MultiMarkdown、 Maruku等。这些衍生版本要么基于工具，如Pandoc；要么基于网站，如GitHub和Wikipedia，在语法上基本兼容，但在一些语法和渲染效果上有改动。
  • Markdown的语法简洁明了、学习容易，而且功能比纯文本更强，因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如Joomla、Drupal都能很好的支持Markdown。完全采用Markdown编辑器的博客平台有Ghost和Typecho。
    用于编写说明文档，并且以“README.md”的文件名保存在软件的目录下面。摘自-百度百科

2.功能快捷键

撤销：Ctrl/Command + Z
重做：Ctrl/Command + Y
加粗：Ctrl/Command + B
斜体：Ctrl/Command + I
标题：Ctrl/Command + Shift + H
无序列表：Ctrl/Command + Shift + U
有序列表：Ctrl/Command + Shift + O
检查列表：Ctrl/Command + Shift + C
插入代码：Ctrl/Command + Shift + K
插入链接：Ctrl/Command + Shift + L
插入图片：Ctrl/Command + Shift + G
查找：Ctrl/Command + F
替换：Ctrl/Command + G

快捷键速览

功能快捷键
撤销Ctrl + Z
重做Ctrl + Y
加粗Ctrl + B
斜体Ctrl + I
标题Ctrl + H
无序列表Ctrl + U
有序列表Ctrl + O
检查列表Ctrl + C
插入代码Ctrl + G
插入链接Ctrl + L
插入图片Ctrl + G
查找Ctrl + F
替换Ctrl + G
引用Ctrl + Q
提升标题Ctrl + H
横线Ctrl + R

3.markdown基础语法

3.1 分级标题

合理的创建标题，有助于目录的生成。直接输入1次#，并按下space后，将生成1级标题。
输入2次#，并按下space后，将生成2级标题。以此类推，markdown目前支持6级标题。

大致效果，如下所示：
在这里插入图片描述
解析为html如下：
在这里插入图片描述
前面带#号，后面带文字，分别表示h1-h6,上图可以看出，只到h6注意，#号后面有空格

推荐两个markdown在线编辑地址，可以用来查看实时效果：
https://www.zybuluo.com/mdeditor
https://tool.oschina.net/markdown/

3.2 改变文本的样式

在这里插入图片描述
对应的效果：

正常文本

强调（倾斜）文本
强调（倾斜）文本

加粗文本
加粗文本

倾斜加粗文本
倾斜加粗文本

标记文本

删除文本

<u>下划线</u> 下划线

引用文本

以下两个写法，在csdn编译器可以友好的解析:

在这里插入图片描述
H2O is是液体
210 运算结果是 1024

3.3 华丽的分割线

编写文档时，分割线也是不可少的。分割线可以由* - _（星号，减号，底线）这3个符号中，每种类型至少3个符号表示。
注意:每种符号至少要3个以上（包含3个），且不需要连续，有空格也可以，但是行内不可以有其他内容，否则分割线无效。
在这里插入图片描述

3.4 插入链接

支持2种链接方式：行内式和参数式，不管是哪一种，链接文字都是用 [方括号] 来标记。

  • 行内式链接
    链接
    在这里插入图片描述
    markdown里面有的可以混合使用，如：链接式列表
  • 参数式链接
    [param]: http://www.baidu.com
    这是参数式[param]链接，改写法不常用，主要使用上面那种方式
    在这里插入图片描述
  • 懒汉式链接
    Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱，只要是用<>包起来，Markdown 就会自动把它转成链接。当然啦，也可以直接写，也是可以自动显示成链接形式的 。
    如：www.baidu.com 或者 <www.baidu.com>，这种写法在csdn上不会生效。
    在这里插入图片描述

3.5 插入图片

  • 插入互联网图片

语法规则：![图片描述信息]（图片网络存储路径）
注意：这个图片描述可以不写。

正常大小的图片
在这里插入图片描述图片1

带尺寸的图片: 在这里插入图片描述Alt

居中的图片:
在这里插入图片描述Alt

居中并且带尺寸的图片: 主要pic_center和后边设置尺寸的“=”之间有空格
在这里插入图片描述Alt

  • 插入本地图片链接
    在这里插入图片描述

3.6 引用

在被引用的文本前加上>符号，以及一个空格就可以了，如果只输入了一个>符号会产生一个空白的引用，可以有多个。

注意：是英文的那个右尖括号，注意空格

  • 基本使用
    使用如下图所示：
    在这里插入图片描述

  • 引用的嵌套使用
    引用因为是一个区块，理论上是应该什么内容都可以放，比如说：标题，列表，引用等等，使用如下图所示：
    在这里插入图片描述
    将上面的代码稍微改一下，全部加上引用标签，就变成了一个大的引用，还有引用里面还有引用，那引用嵌套引用还没有别的写法呢？
    在这里插入图片描述
    上图可以看出，想要在上一次引用中嵌套一层引用，只需多加一个>，理论上可以无限嵌套，我就不整那么多了，注意：多层嵌套的>是不需要连续在一起的，只要在一行就可以了，中间允许有空格，但是为了好看，还是把排版搞好吧。

3.7 列表

  • 无序列表
    使用 *，+，- 表示无序列表。
    注意：符号后面一定要有一个空格，起到缩进的作用。
    在这里插入图片描述

一个tab键，会有不同效果

  • 项目3
    • 项目3
      • 项目3
    • 项目3
      • 项目3
        • 项目3
          • 项目3
      • 项目3
        在这里插入图片描述

  • 有序列表
    使用数字和一个英文句点表示有序列表。
    注意：英文句点后面一定要有一个空格，起到缩进的作用。
    在这里插入图片描述

  • 可选列表

    • a
    • b
    • c
      注意：[ 与]之间要有一个空格
      在这里插入图片描述

  • 列表和其它要素混合使用
    列表不光可以单独使用，也可以和其他的 Markdown语法混合使用，如：标题、引用、代码区块等，感兴趣的可以自己多试试。
    在这里插入图片描述

3.8 转义

基本上跟js语法转义是一样的
在这里插入图片描述

3.9 代码块

这个就比较重要了，写接口文档时，肯定有请求参数，和返回参数，这时候都需要展示出一些代码。
用三个英文式的反引号（```），如果要写注释，可以在反引号后面写
如下图所示：
在这里插入图片描述

  • 代码块里面包含html代码
    在代码区块里面， & 、 < 和 > 会自动转成 HTML 实体，这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始码，只需要复制贴上，剩下的 Markdown 都会帮你处理。
    注意：简书代码块里不支持html。

示例如下：
在这里插入图片描述

3.10 创建一个表格

  • 一个简单的表格是这么创建的：
    在这里插入图片描述
项目Value
电脑$1600
手机$12
导管$1
  • 设定内容居中、居左、居右
    使用:---------:居中
    使用:----------居左
    使用----------:居右

在这里插入图片描述

第一列第二列第三列
第一列文本居中第二列文本居右第三列文本居左

常用的基本语法，基本上就这些了，掌握了以上说的，markdown就差不多够用了。

本文参考链接：

  1. CSDN官方帮助文档
  2. https://www.cnblogs.com/liugang-vip/p/6337580.html
  3. https://blog.csdn.net/u014061630/article/details/81359144

写博客是为了记住自己容易忘记的东西，另外也是对自己工作的总结，希望尽自己的努力，做到更好，大家一起努力进步！

如果有什么问题，欢迎大家一起探讨，代码如有问题，欢迎各位大神指正！

给自己的梦想添加一双翅膀，让它可以在天空中自由自在的飞翔！

緈諨の約錠
关注
专栏目录
Markdown之基础语法
JInterest
09-27 443
认识Markdown Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。 Markdown具有一系列衍生版本，用于扩展Markdown的功能（如表格、脚注、内嵌HTML等等），这些功能原初的Markdown尚不具备，它们能让Markdown转换成更多的格式，例如LaTeX，Docbook。 简单来说，一般我们用的字处理软件Word或Pages有大量的排版、字体设置，而Markdown是个非常容易学习的排版语法。 Markdown 的优点如
Markdown基础语法
Demon
10-03 216
Markdown基础语法
Markdown 语法手册 （完整整理版）
热门推荐
兔清风的博客
09-15 27万+
转载：http://blog.leanote.com/post/freewalk/Markdown%E8%AF%AD%E6%B3%95%E6%89%8B%E5%86%8C 0. 目录 0. 目录1. 斜体和粗体2. 分级标题3. 超链接 3.1. 行内式3.2. 参考式3.3. 自动链接 4. 锚点5. 列表 5.1. 无序列表5.2. 有序列表5.3
Markdown语法的基本使用
最新发布
m0_59470317的博客
09-18 755
这是一篇关于讲解如何正确使用Markdown的排版示例，希望通过此，大家都能轻松上手，都能通过Markdown能够让自己的文章有更加出色、更清晰明了的排版。Markdown (MD) 是现在普遍使用的一种文档书写语言格式，只需用一些非常简单易记的符号，如（# * / > [] ()\ ），就可以轻松写出一篇具有良好的排版和可读性的文章。
Markdown基础语法详细版
jd1813346972的博客
04-22 8828
主要聚焦讲解Markdown基础语法
MarkDown基本语法整理
weixin_34393428的博客
01-12 111
Markdown 语法的简要规则 标题 标题是每篇文章都需要也是最常用的格式，在 Markdown 中，如果一段文字被定义为标题，只要在这段文字前加 # 号即可。 # 一级标题 ## 二级标题 ### 三级标题 以此类推，总共六级标题，建议在井号后加一个空格，这是最标准的 Markdown 语法。 列表 熟悉 HTML 的同学肯定知道有序列表与无序列表的区别，在 Markdow...
Markdown基础语法手册
qq_43571688的博客
02-11 690
Markdown语法速成，Markdown基础语法全覆盖，行云流水写文章，一篇足矣。
markdown基础语法
qq_51578473的博客
08-27 750
markdown基础语法
MarkDown 基础语法速成初级篇
qq_41621535的博客
01-08 319
MarkDown 基础语法半天速成篇 名词解释: MD-MarkDown是一种非常轻量级的标记语言,它允许人们使用易读易写的纯文本格式编写文档， 编写后的文本可以导出为html，word，图像，pdf，epub等多种格式的文档。 一、MarkDown标题 1.使用‘=’和‘-’来标记一级标题和二级标题 输入两个及以上的‘=’和‘-’来标记一级和二级标题 样例： 一级标题 ====== 二级...
Typora与Markdown基础语法指南
"这篇文档是关于Markdown基础语法的学习指南，特别提到了Markdown编辑器Typora的下载方法。文章中还包含了一些Markdown的常用语法示例，如标题、字体样式、引用和图片插入等。" Markdown是一种轻量级的标记语言，它...
MARKDOWN_常用语法
sihenyi24no的博客
03-24 143
MARKDOWN 常用语法标题字体引用分割线图片超链接列表无序列表有序列表列表嵌套表格代码流程图 标题 # 这是一级标题 ## 这是二级标题 ### 这是三级标题 #### 这是四级标题 ##### 这是五级标题 ###### 这是六级标题 字体 *这是倾斜的文字* **这是加粗的文字** ***这是斜体加粗的文字*** ~~这是加删除线的文字~~ 引用 >这是引用的内容 >>这是引用的内容 >>>>>>>>>>这是引用的内容
markdown 基本语法(转载)
weixin_30673611的博客
03-24 209
最近感觉一直使用富文本编辑器写东西，感觉有点烦，所以就试着学习了一下简单的markdown编辑器的使用 原文地址：http://www.jianshu.com/p/815788f4b01d markdown使用进阶地址：http://www.jianshu.com/p/0b257de21eb5 支持原创 主要分为区块元素和区段元素。 区块元素 1.段落和换行 一个 M...
Markdown常用基本语法
再走一步
04-08 1759
1. 标题 # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 2. 分割线 在markdown语法中,一行连用三个或者三个以上的星号,减号,或者下划线,就可以表示分割线。可以在一行用3个以上的 * - _来建立一条分割线，行内除了空格不能有其他东西。 例如: *** 这里是分割线 --- 这里也是分割线 __ 这里还是分割线 据说三条线效果是不同的，按顺序是很明显，不明显，一般。这里三分割线好像也没多大差别。 3.
Markdown 完整语法中文版
weixin_30740581的博客
04-13 139
转自：http://du.5d13.cn/a/itdev/doc/2011/0413/9161.htmlMarkdown: Syntax概述哲學行內 HTML特殊字元自動轉換區塊元素段落和換行標題區塊引言清單程式碼區塊分隔線區段元素連結強調程式碼圖片其它跳脫字元自動連結感謝注意：這份文件是用 Markdown 寫的，你可以看看它的原始檔。概述哲學Markdown 的目標是實現「易讀易寫」。不...
markdown语法
全栈开发的博客
08-05 3581
Markdown是一种轻量级的标记语言，广泛用于文档编辑、博客写作和代码笔记等领域。它具有简洁、易读、易写的特点，可以方便地将文本转换为各种格式的文档。
Markdown 语法
Sigmoid
01-29 5594
基础知识：   Markdown 通过简单标记语法，使普通文本内容具有一定格式。但它本身不支持修改字体、字号与颜色等功能的。   CSDN-markdown 编辑器是其衍生版本，支持基于 PageDown ( Stack Overflow）所使用的编辑器的扩展功能（如表格、脚注、内嵌HTML、内嵌 LaTeX 等等）。 一.标题 1-2 级标题 //用3个或多个(=)和(-)表示一级和二级标题 我展示的是一级标题 === 我展示的是二级标题 --- 1-6 级标题 //用(#)号可表示 1-6 级.
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值