npm 包 `remark-gitlab-artifact` 使用教程

remark-gitlab-artifact 是一个 npm 包，可用于在 GitLab 中插入带有文件下载链接的文件名。本文为您介绍 npm 包 remark-gitlab-artifact 的使用教程。

安装

可以使用 npm 安装 remark-gitlab-artifact，命令如下：

npm install remark-gitlab-artifact

配置

在使用 remark-gitlab-artifact 之前，需要在项目中的 remark 配置中引入此插件。配置示例如下：

const remark = require('remark')
const html = require('remark-html')
const gitlabArtifact = require('remark-gitlab-artifact')

remark()
  .use(gitlabArtifact)
  .use(html)

使用

在 Markdown 中使用 remark-gitlab-artifact 非常简单。只要在需要插入文件名的位置添加以下代码即可：

文件名： `!{<file-name>}`

其中 <file-name> 替换为您需要插入的文件名。例如：

文件名： `!{example.txt}`

示例代码

Markdown

# 我的文件

文件名： `!{example.txt}`

下载链接： `!{<example.txt.url>}`

Config

const remark = require('remark')
const html = require('remark-html')
const gitlabArtifact = require('remark-gitlab-artifact')

remark()
  .use(gitlabArtifact)
  .use(html)

Output

<h1>我的文件</h1>
<p>文件名： <a href="artifact/example.txt">example.txt</a></p>
<p>下载链接： <a href="<example.txt.url>"><example.txt.url></a></p>

总结

本文介绍了 npm 包 remark-gitlab-artifact 的使用教程，涵盖了安装、配置和使用等方面的内容，并且提供了示例代码供读者参考。使用此插件，您可以在 Markdown 文档中插入带有文件下载链接的文件名，非常适合 GitLab 等代码托管平台的文档编写需求。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055fc581e8991b448dd2ee