markdown的使用

6块
129 阅读4分钟

标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

文字加粗

粗体

引用内容

这是引用的内容

www.baidu.com. 这是引用内容

引入图片

vue.jpg

引入代码

var a = 1; console.log(a)

代码块

const TokenKey = import.meta.env.VITE_APP_TOKEN
console.log(TokenKey,'TokenKey in auth.ts')

无序列表

  • 1
  • 2
  • 3

有序列表

  1. 1
  2. 2
  3. 3

删除线

删除线

任务列表

  • [先要做甚么]
  • [其次做什么]

表格

标题

markdown 主题

  1. smarblue主题

image.png

2.fancy主题

image.png

图表

流程图

graph TD
Start --> Stop
开始 --> 第二步 --> ....

在线公众号文章编辑工具

感谢 WeChat Format 源码: github.com/lyricat/wec…

其他工具推荐：

img

Markdown 使用教程

  • Markdown 是什么？
  • 怎么使用 Markdown？

Markdown 是什么？

Markdown是一种轻量级标记语言，它以纯文本形式(易读、易写、易更改)编写文档，并最终以HTML格式发布。

Markdown也可以理解为将以MARKDOWN语法编写的语言转换成HTML内容的工具

为什么 要使用它？

  • 它是易读（看起来舒服）、易写（语法简单）、易更改纯文本。处处体现着极简主义的影子。
  • 兼容HTML，可以转换为HTML格式发布。
  • 跨平台使用。
  • 越来越多的网站支持Markdown。
  • 更方便清晰地组织你的电子邮件。（Markdown-here, Airmail）
  • 摆脱Word。

如果不算扩展，Markdown的语法绝对简单到让你爱不释手。

三、Markdown 语法

Markdown语法主要分为如下几大部分：

标题，段落，区块引用，代码区块，强调，列表，分割线，链接，图片，反斜杠 \，符号'`'。

3.1 标题

两种形式：

1）使用=和-标记一级和二级标题。

一级标题
=========
二级标题
---------

效果：

一级标题

二级标题

2）使用#，可表示1-6级标题。

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

效果：

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

3.2 段落

段落的前后要有空行，所谓的空行是指没有文字内容。若想在段内强制换行的方式是使用两个以上空格加上回车（引用中换行省略回车）。

3.3 区块引用

在段落的每行或者只在第一行使用符号>,还可使用多个嵌套引用，如：

> 区块引用
>> 嵌套引用

效果：

区块引用

嵌套引用

3.4 代码区块

代码区块的建立是在每行加上4个空格或者一个制表符（如同写代码一样）。如
普通段落：

void main()
{
printf("Hello, Markdown.");
}

代码区块：

void main()
{
    printf("Hello, Markdown.");
}

注意:需要和普通段落之间存在空行。

3.5 强调

在强调内容两侧分别加上*或者_，如：

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

效果：

斜体，斜体
粗体，粗体

3.6 列表

使用·、+、或-标记无序列表，如：

-（+*） 第一项 -（+*） 第二项 - （+*）第三项

注意：标记后面最少有一个_空格_或_制表符_。若不在引用区块中，必须和前方段落之间存在空行。

效果：

  • 第一项
  • 第二项
  • 第三项

有序列表的标记方式是将上述的符号换成数字,并辅以.，如：

1 . 第一项
2 . 第二项
3 . 第三项

效果：

  1. 第一项
  2. 第二项
  3. 第三项

3.7 分割线

分割线最常使用就是三个或以上*，还可以使用-和_。

3.8 链接

链接可以由两种形式生成：行内式和参考式。
行内式：

[OpenWrite官网地址](https:://openwrite.cn "OpenWrite")。

效果：

OpenWrite官网地址。

参考式：

[OpenWrite官网地址1][1]
[OpenWrite官网地址2][2]
[1]:https:://openwrite.cn "OpenWrite"
[2]:https:://openwrite.cn "OpenWrite"

效果：

OpenWrite官网地址1
OpenWrite官网地址2

注意：上述的[1]:https:://openwrite.cn "OpenWrite"不出现在区块中。

4.9 图片

添加图片的形式和链接相似，只需在链接的基础上前方加一个！。

4.10 反斜杠\

相当于反转义作用。使符号成为普通符号。

4.11 符号'`'

起到标记作用。如：

`ctrl+a`

效果：

ctrl+a

谁在用？

Markdown 的使用者：

  • GitHub

  • 简书

  • Stack Overflow

  • Apollo

  • Moodle

  • Reddit

  • 等等

#墨滴

TOC 全称为 Table of Content，列出全部标题。由于示例标题过多，需要使用将下方代码段去除即可。

[TOC]

由于微信只支持到二级列表，本工具仅支持二级标题和三级标题的显示。

4.5 注音符号

支持平台：微信公众号。

支持注音符号，用法如下：

Markdown Nice 这么好用，简直是{喜大普奔|hē hē hē hē}呀！

4.6 横屏滑动幻灯片

支持平台：微信公众号。

通过<![](url),![](url)>这种语法设置横屏滑动滑动片，具体用法如下：

<蓝1,绿2,红3>

5 其他语法

5.1 HTML

支持原生 HTML 语法，请写内联样式，如下：

橙色居右 橙色居中

5.2 UML

不支持，推荐使用开源工具https://draw.io/制作后再导入图片

5.3 更多文档

更多文档请参考 mdnice 产品主页

avatar
文章
阅读
粉丝