# @gitlab/nuxt-edit-this-page 中文文档

规范地址：https://npmcn.com/package/%40gitlab/nuxt-edit-this-page/

版本：1\.0\.0
npm 元数据更新时间：2026-11-04T18:04:57.128Z
中文译文更新时间：2026-11-16T12:14:09.484Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gitlab/nuxt-edit-this-page
原文对照：https://npmcn.com/package/%40gitlab/nuxt-edit-this-page/?lang=original
项目主页：https://gitlab.com/gitlab-org/frontend/nuxt-edit-this-page/blob/master/README.md
源码仓库：https://gitlab.com/gitlab-org/frontend/nuxt-edit-this-page

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：12.3 kB，9 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2019-06-19T20:47:13.849Z
- 最新版本发布：2019-06-25T14:18:44.460Z
- 近 30 天下载量：3024（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

在您的 Nuxt 页面中添加“ 编辑此页面” 链接

## 安装

```sh
npm install @gitlab/nuxt-edit-this-page
```

也可以使用：`pnpm add @gitlab/nuxt-edit-this-page`、`yarn add @gitlab/nuxt-edit-this-page`、`bun add @gitlab/nuxt-edit-this-page`

## README

# 这页

[![pipeline status](https://gitlab.com/gitlab-org/frontend/nuxt-edit-this-page/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/frontend/nuxt-edit-this-page/commits/master) [![npm (scoped with tag)](https://img.shields.io/npm/v/@gitlab/nuxt-edit-this-page/latest.svg?style=flat-square)](https://npmjs.com/package/@gitlab/nuxt-edit-this-page) [![npm](https://img.shields.io/npm/dt/@gitlab/nuxt-edit-this-page.svg?style=flat-square)](https://npmjs.com/package/@gitlab/nuxt-edit-this-page)

> 在您的 Nuxt 页面中添加“ 编辑此页面” 链接

[📖 **发布注释**](https://npmcn.com/package/%40gitlab/nuxt-edit-this-page/CHANGELOG.md)

## 特征

本模块允许您在您的 Nuxt 项目的页面中添加“ 编辑此页面” 链接 。 链接打开活动文件的Web IDE,这是该页面默认的Vue文件,但可以通过使用自定义路径解析器来根据需要更改.

## 支持的 Git 服务

-   [吉特拉布语Name](https://gitlab.com/)

## 设置

-   用您最喜欢的软件包管理器安装模块 .

```sh
yarn add @gitlab/nuxt-edit-this-page
# Or npm i @gitlab/nuxt-edit-this-page
```

-   添加 `@gitlab/nuxt-edit-this-page` 页:1 `modules` 节 `nuxt.config.js`。 。 。 .

```js
// nuxt.config.js
{
  modules: [
    '@gitlab/nuxt-edit-this-page',
 ],
}
```

-   通过添加一个 `editThisPage` 键到 `nuxt.config.js`。 。 。 .

```js
// nuxt.config.js
{
  editThisPage: {
    // Module options
  }
}
```

## 使用量

启用时, 模块会注册一个全局组件, 您可以在任何页面中显示“ 编辑此页面” 链接 。 该组件会根据正在访问的路由自动生成链接,以便您能够快速访问Git托管服务的活编辑器.

```vue
<template>
  <edit-this-page-link />
</template>
```

组件接受一些道具来自定义您显示的广告.

## 选项

### 还原

-   **类型**数字 : `String`编号: 需要

文件所在的远程Git寄存器,可以是HTTPS URL或SSH地址.

示例

```js
// nuxt.config.js
{
  editThisPage: {
    repo: 'git@gitlab.com: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.

示例

```vue
<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` 是接收当前路由的函数,并且应当返回相对于寄存器根的计算出的文件路径.

示例

```vue
<template>
  <!-- pages/_slug.vue -->
</template>

<script>
export default {
  editThisPage: {
    resolve({ route }) {
      const { slug } = route.params;
      return `docs/${slug}.md`;
    },
  },
};
</script>
```

## 发展

-   克隆此寄存器
-   使用 `yarn install`
-   开始使用开发服务器 `yarn dev`

## 许可证

[MIT 许可证](https://npmcn.com/package/%40gitlab/nuxt-edit-this-page/LICENSE)

版权 (c) GitLab

## 常见问题

### @gitlab/nuxt-edit-this-page 是什么？

在您的 Nuxt 页面中添加“ 编辑此页面” 链接

### 如何安装 @gitlab/nuxt-edit-this-page？

在项目目录运行 npm install @gitlab/nuxt-edit-this-page，或使用 pnpm add / yarn add / bun add。

### @gitlab/nuxt-edit-this-page 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/gitlab\_\_nuxt-edit-this-page 是否存在。

### @gitlab/nuxt-edit-this-page 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @gitlab/nuxt-edit-this-page 可以商用吗？

@gitlab/nuxt-edit-this-page 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gitlab/nuxt-edit-this-page 的下载量有多少？

根据 npm 官方下载统计，@gitlab/nuxt-edit-this-page 在 2026/10/17 – 2026/11/15 这 30 天内被下载 3,024 次，日均约 101 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gitlab/nuxt-edit-this-page 还在维护吗？

最新版本 1\.0\.0 发布于 2019/06/25（7 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/06/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

