用VsCode写Markdown

Markdown 基本语法

段落

非常自然,一行文字就是一个段落。

比如:

这是一个段落

会被解释成:

<p>这是一个段落。</p>

如果你需要另起一段,请在两个段落之间隔一个空行。

这是一个段落。

这是另一个段落。

会被解释成

<p>这是一个段落</p>

<p>这是另一个段落</p>

不隔一个空行的换行行为,在一些编辑器中被解释为换行,即插入一个<br />标签。
对于另外一些编辑器,会被解释为插入一个空格。对于后者,若要插入换行标签<br />,请在当前一行的结尾打两个空格。
(vscode 就是后者,typora 普通模式是前者,源码模式和 vscode 一样是后者)

没用空一行,在结尾打两个空格的换行,还在一个段落中。

粗体、斜体

可以使用星号*或下划线_指定粗体或者斜体。

*这是斜体*
_这也是斜体_
**这是粗体**
***这是粗体+斜体***

会被解释成

<em>这是斜体</em>
<em>这也是斜体</em>
<strong>这是粗体</strong>
<strong><em>这是粗体+斜体</strong></em>

删除线

一部分编辑器支持删除线,它不是经典 markdown 中的要素。用波浪线~定义删除线。

~~就像这样~~

会被解释成

<strike>就像这样</strike>

标题

markdown 总支持 1~6 六级标题,通过在一行之前加上不同数量的井号来表示。

# 这是 H1 #

## 这是 H2 ##

### 这是 H3 ###

...

###### 这是 H6 ######

行尾可以加上任意数量的井号字符,这些字符不会算作标题内容。通常会加上相等数量的字符以保持对称。

此外,H1 和 H2 也可以采用在文本下方添加底线来实现,比如:

这是 H1
=======

这是 H2
-------

引用

通过在行首加上大于号>来添加引用格式。

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

引用可以嵌套:

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

也可以嵌套其他格式:

> ## 这是一个标题。
>
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
>
> 给出一些例子代码:
>
>     return shell_exec("echo $input | $markdown_script");

这是一个标题。

  1. 这是第一行列表项。
  2. 这是第二行列表项。

给出一些例子代码:

return shell_exec("echo $input | $markdown_script");

列表

无序列表使用星号、加号或是减号作为列表标记:

*   Red
*   Green
*   Blue
  • Red
  • Green
  • Blue

等同于

+   Red
+   Green
+   Blue

-   Red
-   Green
-   Blue

有序列表则使用数字接着一个英文句点:

1.  Bird
2.  McHale
3.  Parish
  1. Bird
  2. McHale
  3. Parish

内联代码

用反引号 ` 来标记内联代码,它们会解释成 <code> 标签。如果代码的内容中有反引号,请用两个反引号包裹。

代码区域

有两种方式标记代码区域,原生风格是行首缩进四个空格。

这是一个普通段落:

这是一个代码区块。

会被解释成

<p>这是一个普通段落:</p>

<pre><code>这是一个代码区块。
</code></pre>

分隔线

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

* * *
***
*****
- - -
---------------------------------------

链接

[an example](http://example.com/)
[an example](http://example.com/ "Optional Title")

会被解释为

<a href='http://example.com/'>an example</a>
<a href='http://example.com/' title="Optional Title">an example</a>

除了上面的行内式,也可以使用参考式:

[an example][id]

然后在任意空白位置定义:

[id]: http://example.com/ "Optional Title"

图像

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional Title")

会被解释为

<img src='/path/to/img.jpg' alt='Alt text' />
<img src='/path/to/img.jpg' alt='Alt text' title='Optional Title' />

同样,图像也有类似的参考式语法。

自动链接

如果链接的地址和名字重复,可以用尖括号语法将其简化。

<http://example.com/>

就相当于

[http://example.com/](http://example.com/)

切记,大多数编辑器都会自动将符合url规则的东西视为链接,并且解释成链接。很多时候作者由于疏忽等缘故,链接和后面的中文之间缺少空格,导致链接不正常。所以我建议,链接要么加上尖括号,要么两端加上空格。

转义

markdown支持在以下字符前面插入反斜杠

\   反斜线
`   反引号
*   星号
_   底线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号

表格

| Item     | Value |  Qty  |
| :------- | ----: | :---: |
| Computer | $1600 |   5   |
| Phone    |   $12 |  12   |
| Pipe     |    $1 |  234  |

会被解释成

<table>
<thead>
<tr>
  <th align="left">Item</th>
  <th align="right">Value</th>
  <th align="center">Qty</th>
</tr>
</thead>
<tbody><tr>
  <td align="left">Computer</td>
  <td align="right">$1600</td>
  <td align="center">5</td>
</tr>
<tr>
  <td align="left">Phone</td>
  <td align="right">$12</td>
  <td align="center">12</td>
</tr>
<tr>
  <td align="left">Pipe</td>
  <td align="right">$1</td>
  <td align="center">234</td>
</tr>
</tbody></table>

要注意第二行的冒号决定了居左居右还是居中,如果你不加冒号,默认是居左的。

另外可以把第一行去掉,做成没有表头的表格,但第二行始终是要有的。

内联 HTML

markdown 的语法简洁,但有其局限性,所以特意保留了内联html这种方式。任何html标签及其内容,都会原样输出到结果中。也就是说,标签中的星号等作为markdown结构的符号,以及构成html标签和实体的符号,都不会做任何转义。

vscode markdown 扩展

Markdown All in One
Markdown Shortcuts

最后

本文的另外链接是:https://herodanny.github.io/vscode-write-markdown.html

转载于:https://www.cnblogs.com/yindanny/p/10732336.html

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
VSCode是一个非常流行的文本编辑器,可以用来编Markdown文件。下面是一些使用VSCodeMarkdown的基本步骤: 1. 安装VSCode:首先,你需要下载并安装VSCode编辑器。你可以在VSCode官方网站上找到适合你操作系统的安装包,并按照提示进行安装。 2. 安装Markdown扩展:打开VSCode后,点击左侧侧边栏中的扩展图标(四个方块组成的正方形),搜索并安装适合Markdown的扩展。一些受欢迎的扩展包括"Markdown All in One"和"Markdown Preview Enhanced"。 3. 创建或打开Markdown文件:在VSCode中,你可以创建一个新的Markdown文件,或者打开一个已存在的Markdown文件。点击左上角的"文件",选择"新建文件"或者"打开文件",然后选择一个Markdown文件。 4. 编Markdown内容:在Markdown文件中,你可以使用Markdown语法来编内容。Markdown语法是一种简单且易于学习的标记语言,用于将文本格式化为结构化的文档。你可以使用#标识标题、*和-标识列表、`标识代码块等等。具体的语法规则你可以在网络上找到相关教程。 5. 预览Markdown文档:VSCode中的Markdown扩展通常提供了预览功能,可以实时将Markdown文档渲染成漂亮的格式。你可以使用快捷键Ctrl+Shift+V(在Windows和Linux上)或者Cmd+Shift+V(在Mac上)来打开预览窗口。 6. 导出Markdown文件:如果你想将Markdown文件导出为其他格式(如HTML或PDF),可以使用VSCode中的扩展或者插件来完成。一些流行的扩展包括"Markdown PDF"和"Pandoc Markdown Export"。 希望以上步骤对你编Markdown文件有所帮助!如果你有任何其他问题,请随时提问。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值