这页
在您的 Nuxt 页面中添加“ 编辑此页面” 链接
特征
本模块允许您在您的 Nuxt 项目的页面中添加“ 编辑此页面” 链接 。 链接打开活动文件的Web IDE,这是该页面默认的Vue文件,但可以通过使用自定义路径解析器来根据需要更改.
支持的 Git 服务
设置
- 用您最喜欢的软件包管理器安装模块 .
yarn add @gitlab/nuxt-edit-this-page
# Or npm i @gitlab/nuxt-edit-this-page
- 添加
@gitlab/nuxt-edit-this-page页:1modules节nuxt.config.js。 。 。 .
// nuxt.config.js
{
modules: [
'@gitlab/nuxt-edit-this-page',
],
}
- 通过添加一个
editThisPage键到nuxt.config.js。 。 。 .
// nuxt.config.js
{
editThisPage: {
// Module options
}
}
使用量
启用时, 模块会注册一个全局组件, 您可以在任何页面中显示“ 编辑此页面” 链接 。 该组件会根据正在访问的路由自动生成链接,以便您能够快速访问Git托管服务的活编辑器.
<template>
<edit-this-page-link />
</template>
组件接受一些道具来自定义您显示的广告.
选项
还原
- 类型数字 :
String编号: 需要
文件所在的远程Git寄存器,可以是HTTPS URL或SSH地址.
示例
// nuxt.config.js
{
editThisPage: {
repo: '[email protected]:gitlab-org/frontend/nuxt-edit-this-page.git',
// Or
// repo: 'https://gitlab.com/gitlab-org/frontend/nuxt-edit-this-page.git',
// Also works with the project's URL
// repo: 'https://gitlab.com/gitlab-org/frontend/nuxt-edit-this-page',
}
}
路径
- 类型数字 :
String - 默认数字 :
'blob'
这个 path 选项附加在基准编辑 URL 上。 默认情况下,会使用blob路径,该路径会产生 URL 如 https://gitlab.com/gitlab-org/frontend/nuxt-edit-this-page/blob/master/README.md。此选项可用于使 URL 点直接到编辑路径, ie 设置 path 改为 'edit' 将生成像 https://gitlab.com/gitlab-org/frontend/nuxt-edit-this-page/edit/master/README.md。 。 。 .
分支
- 类型数字 :
String - 默认数字 :
'master'
编辑文件时使用的 Git 分支 .
链接文本
- 类型数字 :
String - 默认数字 :
'Edit this page'
提供链接时要显示的文本 .
组件Name
- 类型数字 :
String - 默认数字 :
'EditThisPageLink'
组件名.
道具
组件接受一些道具,如果需要,可以让您覆盖模块的选项.
编辑Url
- 类型 :
String
创建编辑链接时, 将 URL 设置为文件路径 。 这是根据 repo 财务报告和审定财务报表 branch 选项,当您需要按具体情况覆盖 URL时使用.
链接文本
- 类型 :
String
提供链接时要显示的文本 。 默认模块选项中设置的值 .
限定档次
该组件会暴露出一个可自定义渲染时所使用范围槽,如果道具过于有限. 槽接收属性 href 包含已计算编辑 URL.
示例
<template>
<edit-this-page-link>
<template v-slot:default="{ href }">
<span>Customized link pointing to {{ href }}</span>
</template>
</edit-this-page-link>
</template>
自定义路径解析器
有时,您的页面会显示来自其他文件的内容,您可能希望“编辑此页面”链接指向包含的文件,而不是访问的页面组件。 可通过增加 editThisPage.resolve 选项到页面. editThisPage.resolve 是接收当前路由的函数,并且应当返回相对于寄存器根的计算出的文件路径.
示例
<template>
<!-- pages/_slug.vue -->
</template>
<script>
export default {
editThisPage: {
resolve({ route }) {
const { slug } = route.params;
return `docs/${slug}.md`;
},
},
};
</script>
发展
- 克隆此寄存器
- 使用
yarn install - 开始使用开发服务器
yarn dev
许可证
版权 (c) GitLab