Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
计算机应用开发
前端
Vuepress
提交
adb08a21
V
Vuepress
项目概览
计算机应用开发
/
前端
/
Vuepress
通知
2
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
V
Vuepress
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
adb08a21
编写于
11月 14, 2018
作者:
U
ULIVZ
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs: readme of @vuepress/markdown
上级
6a20c40f
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
36 addition
and
22 deletion
+36
-22
packages/@vuepress/markdown/README.md
packages/@vuepress/markdown/README.md
+36
-22
未找到文件。
packages/@vuepress/markdown/README.md
浏览文件 @
adb08a21
# @vuepress/markdown
> markdown for vuepress
> markdown
library
for vuepress
##
Usage
##
Public API
```
javascript
const
createMarkdown
=
require
(
'
@vuepress/markdown
'
)
const
md
=
createMarkdown
(
/* options */
)
```
## Options
### PLUGINS
### slugify
A map
[
constant
](
./lib/constant.js
)
containing the names of all built-in markdown-it plugins.
-
TODO
### isRequiredPlugin(pluginName: string)
### externalLinks
-
**Usage**
:
-
TODO
```
js
const
{
isRequiredPlugin
}
=
require
(
'
@vuepress/markdown
'
)
console
.
log
(
isRequiredPlugin
(
PLUGINS
.
COMPONENT
))
// true
console
.
log
(
isRequiredPlugin
(
PLUGINS
.
HIGHLIGHT_LINES
))
// false
```
###
anchor
###
removePlugin(config: chainMarkdown, pluginName: string)
-
TODO
Remove the specified built-in markdown-it plugin in VuePress.
### toc
It's needed to use with VuePress's
[
Plugin API > chainMarkdown
](
https://vuepress.vuejs.org/plugin/option-api.html#chainmarkdown
)
.
-
TODO
-
**Usage**
:
### lineNumbers
```
js
// You VuePress Plugin or site config.
const
{
removePlugin
}
=
require
(
'
@vuepress/markdown
'
)
module
.
exports
=
{
chainMarkdown
(
config
)
{
removePlugin
(
config
,
PLUGINS
.
HIGHLIGHT_LINES
)
}
}
```
-
TODO
> Note that `PLUGINS.COMPONENT` and `PLUGINS.ANCHOR` are required in VuePress, It is forbidden to delete them!
###
beforeInstantiate
###
removeAllBuiltInPlugins(config: chainMarkdown)
-
TODO
Remove all built-in but not 100% necessary markdown-it plugins in VuePress.
### afterInstantiate
-
**Usage**
:
-
TODO
```
js
// You VuePress Plugin or site config.
module
.
exports
=
{
chainMarkdown
(
config
)
{
require
(
'
@vuepress/markdown
'
).
removeAllBuiltInPlugins
(
config
)
}
}
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录