简介
@vuepress/markdown 是 VuePress 项目中的一个核心模块,负责将 Markdown 格式的文章转换成静态网页。本文将介绍该 npm 包的使用方法,以及一些基本的 Markdown 语法。
安装
使用 npm 安装 @vuepress/markdown,命令如下:
--- ------- ------------------
使用
引入 @vuepress/markdown
在 VuePress 的配置文件中,配置 markdown
属性为 @vuepress/markdown
即可使用。示例代码如下:
-------------- - - --------- ----------------------------- -
配置
@vuepress/markdown 提供了许多配置选项,用于自定义 Markdown 的解析方式和渲染效果。以下是一些常用配置:
anchor
- 类型:boolean
- 默认值:true
设置为 false
可以关闭自动生成标题的锚点链接。示例代码如下:
-------------- - - --------- - ------- ----- - -
externalLinks
- 类型:Object
- 默认值:{}
用于配置外部链接的行为。将链接与外部域名映射为打开方式。示例代码如下:
-------------- - - --------- - -------------- - ------- --------- ---- --------- ----------- - - -
plugins
- 类型:Array
- 默认值:[]
用于配置插件,包括 MarkdownIt 插件和 VuePress 插件。示例代码如下:
-------------- - - --------- - -------- - -- ---------- -- --------------------------- --------------------------------- -- -------- -- ----------------------------------------- -------------------------------- - - -
Markdown 语法
Markdown 是一种轻量级标记语言,它可以被转换成 HTML 或者其他格式。下面介绍一些常用的 Markdown 语法。
标题
在行首插入若干个 #
号,用于表示不同级别的标题。示例代码如下:
- ---- -- ---- --- ---- ---- ---- ----- ---- ------ ----
段落
在段落之间使用空行即可。示例代码如下:
----- -----
加粗和斜体
在需要加粗的文字前后使用两个 *
号,需要斜体的文字前后使用一个 *
号。示例代码如下:
-------- ------
列表
使用 -
或者 *
开始的一行表示一个无序列表项,使用数字和 .
开始的一行表示一个有序列表项。示例代码如下:
- ----- - - ----- - - ----- - -- ----- - -- ----- - -- ----- -
插入图片
使用 ![](图片地址)
插入图片。示例代码如下:
----------------------------------
插入链接
使用 [](链接地址)
插入链接。示例代码如下:
---------------------------
示例代码
以下是使用 @vuepress/markdown 进行渲染的示例代码。
- ------ --------- ------ -------------------- ------ -- -- -------- -------------------------- -- -- -- --- -- -------------------------- -------- --- ------- ------------------
Markdown 语法
VuePress 使用 markdown-it
进行 Markdown 渲染,支持大部分的 Markdown 语法。
- ---- -- ---- ----------- --------- --- - ----- - - ----- - - ----- - -- ----- - -- ----- - -- ----- - --------------------------------------- --------------------------------
结语
VuePress 是一个非常强大的工具,可以灵活地配置你的网站,让你可以专注于文章创作。感谢你的阅读!
-- -- ------------------ - -------- ------------------------------- --- ---------- -------- --- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------