0%

Docusaurus禁用“编辑此页面”链接

最近在用Docusaurus V2.0编写产品的文档,发现生成的文档页面左下角会有个“编辑此页面”(英文版是”Edit this page”)的链接。因为这个文档交付给客户后其实没必要再进行编辑了,所以需要看下如何禁用掉这个链接。

全局禁用

如果需要全局禁用这个链接,可以编辑下docusaurus.config.js配置文件,将presets部分docs配置的editUrl设置为”undefined”,修改完的配置片段是这样的:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
routeBasePath: '/',
// 设置为undefined全局禁用编辑链接
editUrl: undefined,
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
},
],
],

部分页面禁用

如果需要在部分文档页面中禁用编辑链接,则可以在文档的前言部分将custom_edit_url设置为null,下面是一个示例:

1
2
3
4
---
title: 测试页面
custom_edit_url: null
---

参考链接

如果我的文字帮到了您,那么可不可以请我喝罐可乐?