什么是 remark-external-links
remark-external-links
是一个可以根据 URL 将 Markdown 文件中的外部链接转换为 HTML 链接的 remark 插件。这个插件可以将您的 Markdown 文件中的所有外部链接转换为合法的 HTML 链接,并且还可以在链接目标处添加 noopener
和 noreferrer
属性以提高网页安全性。
怎样安装 remark-external-links
您可以通过 npm 来安装 remark-external-links
插件:
npm install remark-external-links
怎样使用 remark-external-links
引入 remark-external-links
您需要引入 remark-external-links
插件,并将其添加到您的 remark 插件列表中去:
const remark = require('remark'); const externalLinks = require('remark-external-links'); remark() .use(externalLinks, { target: '_blank', rel: ['noopener', 'noreferrer'] }) .process(markdownString, (err, output) => { console.log(String(output)); });
选项
您可以向 remark-external-links
传递一些选项进行自定义:
target
- Type:
string
- Default:
'_blank'
指定链接的目标,在本例中默认为 _blank
。
rel
- Type:
Array<string>
- Default:
['noopener', 'noreferrer']
定义链接的 rel
属性组。在本例中,我们指定为 ['noopener', 'noreferrer']
,以减少与打开新窗口相关的安全问题。
示例
例如,如果我们有一个 Markdown 文件,其中包含以下外部链接:
[remark-external-links](https://github.com/ben-eb/remark-external-links)
使用 remark-external-links
插件,我们可以将链接转换为 HTML 链接:
<a href="https://github.com/ben-eb/remark-external-links" target="_blank" rel="noopener noreferrer">remark-external-links</a>
结论
remark-external-links
是一个非常有用的 remark 插件,它可以自动转换外部链接为 HTML 链接,并提高网页安全性。希望此篇使用教程可以帮助您更好地使用 remark-external-links
。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/58031