3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-10 07:37:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source
This commit is contained in:
Yangshun Tay 2020-01-01 18:45:55 +08:00 • committed by GitHub
parent 428e087eb7
commit 75f5bb4d23
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 42 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/ipsum.md Normal file
View file

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

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

@ -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,

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

@ -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 = {

2
packages/docusaurus-plugin-content-docs/src/metadata.ts
View file

@ -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,