优秀的编程知识分享平台

网站首页 > 技术文章 正文

沉浸式写markdown文档(沉浸式平台)

nanyue 2024-08-04 16:46:53 技术文章 6 ℃

一、标题的表示方法

1.在标题行下加“=”为一级标题,在标题行下加“-”为二级标题。
2.使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推

———————例子————————— ——————————————————

一级标题!

二级标题!

三级标题!

四级标题!

五级标题!

六级标题!

—————————————————— ——————————————————

二、段落格式

2.1 段落

1.段的换行:使用两个以上空格加上回车。
2.段
的换行:可以在两段之间加一个空行,表示开始下一段。

2.2 字体

1.斜体文本:在字体两端加上“”或者“”。
2.
粗体文本:在字体两端加上“”或者“”。
3.
粗斜体文本:在字体两端加上“**”或者“
__”。

2.3 分割线

在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。


"- - -"


"*****"


"______"

2.4 删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可。
删除文本

2.5 下划线

下划线可以通过 HTML 的<u> 标签来实现。
<u>
下划线</u>
下划线

2.6 脚注

对文本的说明补充,创建脚注,命令如下, [^这是脚注]
[^这是脚注]:1+1=2。


这是例子[1]。

三、列表

3.1 无序列表

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记


*第一列
*第二列


  • 第一列
  • 第二列

3.2 有序列表

有序列表使用数字并加上 . 号来表示

3.3 列表嵌套

列表嵌套只需在子列表中的选项添加四个空格即可
注:序号和符号与文字之间需要空格


  1. 选项1第一个元素第二个元素

四、区块引用

  1. Markdown区块引用是在段落开头使用 > 符号,然后后面紧跟一个空格符号

>第一区
>第二区


第一区
第一区


  1. 区块嵌套,一个>符号是最外层两个>符号是第一层嵌套,以此类推。

>第一层
>>第二层
>>>第三层


第一层

第二层

第三层


3. 区块中使用列表


> 区块
> 1. 列表1
> 2. 列表2


区块

列表1列表2


4. 列表里插入区块
在列表项目内放进区块,那么就需要在 >
前添加四个空格的缩进


  1. 列表1
  2. 列表2
    > 区块1
    > 区块2

  1. 列表1
  2. 列表2
  3. 区块1
    区块2

五、代码

段落上的一个函数或片段的代码可以用反引号把它包起来(`)


`print()`
print()

代码区块:

代码区块使用4个空格或者一个制表符(Tab 键)


print("Hello world!")
print("Hello World!!")

可以用```包裹一段代码,并指定一种语言(也可以不指定)。

七、链接表示方式

7.1 普通链接


写法:
这是一个链接[百度](www.baidu.com)
或者,这是一个百度的链接<www.baidu.com>


效果:
这是一个链接百度


7.2 高级链接

可以通过变量来设置一个链接,变量赋值在文档末尾进行。


用 1 给百度赋值[百度][1]

[1]: www.baidu.com


用 1 给百度赋值百度


八、图片展示

语法格式:

![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")


开头!接着一个方括号,里面放上图片的替代文字。接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 'title' 属性的文字。



Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 标签

<img src="地址" width="50%">


九、表格

制作表格使用 | 来分隔不同的单元格使用 - 来分隔表头和其他行


表头表头单元格单元格单元格单元格


对齐方式

-: 设置内容和标题栏居对齐:- 设置内容和标题栏居对齐:-: 设置内容和标题栏居中对齐


左对齐居中右对齐左对齐1居中1右对齐1


十、高级应用

10.1 支持的 HTML 元素

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写

目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等


10.2 转义字符

“\“

10.3 公式

当你需要在编辑器中插入数学公式时,可以使用两个美元符 $ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。

最近发表
标签列表