feat(v2): allow per-doc hiding of edit url (#2166)

packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/ipsum.md

@@ -0,0 +1,5 @@
+---
+custom_edit_url: null
+---
+
+Lorem ipsum.

packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap

@@ -84,6 +84,14 @@ Array [
         },
         "path": "/docs/hello",
       },
+      Object {
+        "component": "@theme/DocItem",
+        "exact": true,
+        "modules": Object {
+          "content": "@site/docs/ipsum.md",
+        },
+        "path": "/docs/ipsum",
+      },
       Object {
         "component": "@theme/DocItem",
         "exact": true,

packages/docusaurus-plugin-content-docs/src/__tests__/metadata.test.ts

@@ -143,6 +143,34 @@ describe('simple site', () => {
     });
   });
 
+  test('docs with null custom_edit_url', async () => {
+    const source = 'ipsum.md';
+    const options = {
+      routeBasePath,
+      showLastUpdateAuthor: true,
+      showLastUpdateTime: true,
+    };
+
+    const data = await processMetadata({
+      source,
+      refDir: docsDir,
+      context,
+      options,
+      env,
+    });
+
+    expect(data).toEqual({
+      id: 'ipsum',
+      permalink: '/docs/ipsum',
+      source: path.join('@site', routeBasePath, source),
+      title: 'ipsum',
+      editUrl: null,
+      description: 'Lorem ipsum.',
+      lastUpdatedAt: 1539502055,
+      lastUpdatedBy: 'Author',
+    });
+  });
+
   test('docs with invalid id', async () => {
     const badSiteDir = path.join(fixtureDir, 'bad-site');
     const options = {

packages/docusaurus-plugin-content-docs/src/metadata.ts

@@ -134,7 +134,7 @@ export default async function processMetadata({
     description,
     source: aliasedSitePath(filePath, siteDir),
     permalink,
-    editUrl: custom_edit_url || docsEditUrl,
+    editUrl: custom_edit_url !== undefined ? custom_edit_url : docsEditUrl,
     version,
     lastUpdatedBy,
     lastUpdatedAt,