Markdown写作指北

什么是Markdown？

Markdown的发展历史可以追溯到2004年，由约翰·格鲁伯（John Gruber）和亚伦·斯沃茨（Aaron Swartz）共同开发。其核心目标是提供一种“易读、易写”的纯文本格式，同时能轻松转换为HTML，以减少传统HTML编写时的繁琐性

对的，Markdown其实是HTML的一种替代品。由于IT与其相关领域的文章其实不需要复杂的样式，五花八门的交互，而是注重于文章本身。所以Markdown就成为了这些领域的社区常用的写作语言。

readme.cn.md^[1]

电子音乐的编曲，其实与电子信息与计算机科学的技术脱不开关系，很多时候的呈现也更多是面向内容本身的。所以强烈推荐投稿者使用Markdown进行写作。仅在部分需要更加多样的展现方式的时候才使用HTML+CSS+JS。

Markdown的语法

Markdown 教程

这上面的网站是我高中时学习Markdown的入门网站（其实Markdown极其容易上手，只要会用几乎就等于精通，~~Mermaid等图表除外~~）

Tips：其实一部分语法可以直接使用快捷按键，分别在编辑器的上面和左栏。后面也会讲到。

标题

作为最基本的元素，标题几乎是每个人都一定会用到的。

而Markdown的标题用 “#” 表达。且数量越多代表的标题级数就越小，最小为6级标题

下面是一个示例：

# 这是一个一级标题
## 这是一个二级标题
### 这是一个三级标题
#### 这是一个四级标题
...

列表.webp
上面是在markdown编辑器里的快捷图标，可以直接选择

使用好标题对于基本的阅读体验是会有极其高的提升，而且后期如果有可能或许能加入侧边栏显示目录功能，则可以使阅读更加轻松！

粗体&&斜体

粗体是在段落中加粗字体的语法，可以用来强调重要段落

斜体也具有相同的作用，但是其实其并不好用，因为这玩意放在一堆排版不佳的文本中时，不容易被注意到，反而起不到作用，所以建议还是在配合CSS来起到美化作用

其实粗体与斜体还可以组合使用

下面是上面文本的语法：

**粗体是在段落中加粗字体的语法，可以用来强调重要段落*  

*斜体也具有相同的作用，但是其实其并不好用，因为这玩意放在一堆排版不佳的文本中时，不容易被注意到，反而起不到作用，所以建议还是在配合CSS来起到美化作用*

***其实粗体与斜体还可以组合使用***

删除线与上下标

_下标内容^上标

这是下面是上面的语法

 ~下标~内容^上标^   //~内容~表示下标    ^内容^表示上标

引用块与代码块

Using a greater-than symbol, followed by a space, before each line of text.
使用大于号，后面跟一个空格，在每个文本行之前。

let num1 = prompt('请输入第一个数字');
let num2 = prompt('请输入第二个数字');
alert(`交换前的两个数字是${num1}和${num2}`);
let temp = num1;
num1 = num2;
num2 = temp;
alert(`交换后的两个数字是${num1}和${num2}`);

> 引用块用于引用内容，比如别的文章的解释，谚语，名言，诗词之类的

对于wiki.js的Markdown编辑器对于引用块还有很多的美化方式

比如：

信息型引用
成功型引用
警告型引用
错误型引用

下面是这些方式的使用方法：

信息型引用

> 信息型引用
{.is-info}

成功型引用

> 成功型引用
{.is-success}

警告型引用

> 警告型引用
{.is-warning}

错误型引用

> 错误型引用
{.is-danger}

下面是代码块的写法

    \```Javascript "\"是转义符号，无实际意思，只是为了代码块的语法能被展现出来而不被渲染
  			\\就是两行”```“在这之间写代码，在第一个"```"后接上语言名称可以高亮语法。
  \```

列表

无序列表

这是一个无序列表
这也是
这还是

写法如下：

- 这是一个无序列表
- 这也是
<br>
- 这还是

无序列表.webp
上面是无序列表在编辑器里的快捷按键，直接点击就可以插入无序列表，回车就可以添加新的条目

链接

你可以使用[]后跟一个()来创建一个简单的超链接。


wow,这是[baka](example.com)！

下面是他的结果：

wow,这是baka！

你也可以使用尖括号<>把链接变成可点击的,你也可以对邮箱使用。


笨蛋！这是我的Email:<bakahome@example.com>

下面是他的结果：
笨蛋！这是我的Email:bakahome@example.com

你可以在链接中随意使用格式化、强调引用，也可以在大部分地方使用链接。

这是链接到[这里](#link)的链接。

这是链接到这里的链接

Tips:由于本网站的特殊性，建议引用站内文章时使用快捷选项，其使用的是相对路径，相对稳定
链接.webp

分隔线

你可以方便地使用多个-来分隔，推荐使用后保留一行空白行

这是例子：

不要

---

分隔我！

这是输出：

不要

分隔我！

表格

你可以用三个或多个-来创建每列的标题，并使用|来作为分隔，你可以选择任意方法添加分隔；
使用:来决定对齐；
你可以在表格中使用反引号`来格式化。
虽然可以完全不用管表格在文字状态下像不像表格，但是为了方便编辑还是像一些好。

想要在表格中换行？使用html的<br>！
想要在表格中用无序列表？使用html的<ul>与<li>，并用</li>结束一个无序列表。

这是例子


|1   |4   |7             |it's|
|---:|:---|--------------|:--:
|2222|5555|9<br><br>114 |a
|3   |6   |<ul><li>10</li><li>514</li><ul> |`baka`

下面是他的输出

1	4	7	it's
2222	5555	9 114	a
3	6	10 514	`baka`

脚注

这是一个测试脚注。^[2]

这是上面的这段话的实现方式，目前编辑器并没有快捷选项来直接添加脚注

  这是一个测试脚注。[^2]	 //在文章中需要脚注的地方添加[^n](n为第几个脚注)	
  [^2]:注意不要与脚注所在的标题的内容里使用\<br>和任何html标签,否则会失效。
  如果要写这些标签，而不想它们起作用，可以使用代码块或者在这些标签前面“\”这个转义符号。
  //在文章末尾(推荐，事实上你写哪都行)，添加[^n]: ---这是脚注内容---

Mermaid

Mermaid也是一种标记语言，wiki.js的Markdown编辑器中支持用在代码块中写Mermaid来渲染

flowchart TD A(["Start"]) A --> B{"Decision"} B --> C["Option A"] B --> D["Option B"]

\```mermaid   //一定要记得在这里加上mermaid的名称
flowchart TD
        A(["Start"])
        A --> B{"Decision"}
        B --> C["Option A"]
        B --> D["Option B"]
\```

不建议直接使用语法编写mermaid(~~太难了~~)

最好还是请AI帮忙画

注释

<!--这是注释-->  //讲真别乱用，这个玩意毕竟是html里面的标签，在Markdown里面总是
  							//可能产生意想不到的后果
  							//使用方法就是用<!----> 这其实是两部分前面的部分"<!--"  后面的部分"-->"
  							//里面包裹的就是要注释的内容，

注释不会被渲染，也就不会显示出来，主要用于给其他协作者一些提示，具体使用看情况，
用完一定要删！！！

这就是一个经典的例子，来源于Open-LLM-Vtuber这个项目 ↩︎
注意不要与脚注所在的标题的内容里使用<br>和任何html标签,否则会失效。如果要写这些标签，而不想它们起作用，可以使用代码块或者在这些标签前面“\”这个转义符号。 ↩︎

Markdown语法须知