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

feat: allow custom docsUrl & custom permalink

Browse source
This commit is contained in:
endiliey 2018-09-12 01:00:31 +08:00
parent 185f7b1ed1
commit b99605f725
12 changed files with 270 additions and 177 deletions
Download patch file Download diff file Expand all files Collapse all files

84
test/load/docs/metadata.test.js
View file

@ -5,17 +5,17 @@ import loadSetup from '../../loadSetup';
describe('processMetadata', () => {
test('normal docs', async () => {
const props = await loadSetup('simple');
const {docsDir, env} = props;
const {docsDir, env, siteConfig} = props;
const sourceA = path.join('foo', 'bar.md');
const sourceB = path.join('hello.md');
const dataA = await processMetadata(sourceA, docsDir, env, {});
const dataB = await processMetadata(sourceB, docsDir, env, {});
const dataA = await processMetadata(sourceA, docsDir, env, {}, siteConfig);
const dataB = await processMetadata(sourceB, docsDir, env, {}, siteConfig);
expect(dataA).toEqual({
id: 'foo/bar',
language: undefined,
localized_id: 'foo/bar',
permalink: 'docs/foo/bar',
source: 'foo/bar.md',
permalink: '/docs/foo/bar',
source: '@docs/foo/bar.md',
title: 'Bar',
version: undefined
});
@ -23,27 +23,43 @@ describe('processMetadata', () => {
id: 'hello',
language: undefined,
localized_id: 'hello',
permalink: 'docs/hello',
source: 'hello.md',
permalink: '/docs/hello',
source: '@docs/hello.md',
title: 'Hello, World !',
version: undefined
});
});
test('docs with custom permalink', async () => {
const props = await loadSetup('simple');
const {docsDir, env, siteConfig} = props;
const source = path.join('permalink.md');
const data = await processMetadata(source, docsDir, env, {}, siteConfig);
expect(data).toEqual({
id: 'permalink',
language: undefined,
localized_id: 'permalink',
permalink: '/docs/endiliey/permalink',
source: '@docs/permalink.md',
title: 'Permalink',
version: undefined
});
});
test('versioned docs (without translation)', async () => {
const props = await loadSetup('versioned');
const {siteDir, docsDir, env} = props;
const {siteDir, env, siteConfig} = props;
const refDir = path.join(siteDir, 'versioned_docs');
const sourceA = path.join('version-1.0.0', 'foo', 'bar.md');
const sourceB = path.join('version-1.0.0', 'hello.md');
const dataA = await processMetadata(sourceA, refDir, env, {});
const dataB = await processMetadata(sourceB, refDir, env, {});
const dataA = await processMetadata(sourceA, refDir, env, {}, siteConfig);
const dataB = await processMetadata(sourceB, refDir, env, {}, siteConfig);
expect(dataA).toEqual({
id: 'version-1.0.0-foo/bar',
language: undefined,
localized_id: 'version-1.0.0-foo/bar',
permalink: 'docs/1.0.0/foo/bar',
source: 'version-1.0.0/foo/bar.md',
permalink: '/docs/1.0.0/foo/bar',
source: '@versioned_docs/version-1.0.0/foo/bar.md',
title: 'Bar',
version: '1.0.0'
});
@ -51,8 +67,8 @@ describe('processMetadata', () => {
id: 'version-1.0.0-hello',
language: undefined,
localized_id: 'version-1.0.0-hello',
permalink: 'docs/1.0.0/hello',
source: 'version-1.0.0/hello.md',
permalink: '/docs/1.0.0/hello',
source: '@versioned_docs/version-1.0.0/hello.md',
title: 'Hello, World !',
version: '1.0.0'
});
@ -60,22 +76,22 @@ describe('processMetadata', () => {
test('translated versioned docs', async () => {
const props = await loadSetup('transversioned');
const {siteDir, docsDir, env} = props;
const {siteDir, env, siteConfig} = props;
const refDir = path.join(siteDir, 'translated_docs');
const sourceA = path.join('ko', 'version-1.0.0', 'foo', 'bar.md');
const sourceB = path.join('ko', 'version-1.0.0', 'hello.md');
const sourceC = path.join('ko', 'version-1.0.1', 'foo', 'bar.md');
const sourceD = path.join('ko', 'version-1.0.1', 'hello.md');
const dataA = await processMetadata(sourceA, refDir, env, {});
const dataB = await processMetadata(sourceB, refDir, env, {});
const dataC = await processMetadata(sourceC, refDir, env, {});
const dataD = await processMetadata(sourceD, refDir, env, {});
const dataA = await processMetadata(sourceA, refDir, env, {}, siteConfig);
const dataB = await processMetadata(sourceB, refDir, env, {}, siteConfig);
const dataC = await processMetadata(sourceC, refDir, env, {}, siteConfig);
const dataD = await processMetadata(sourceD, refDir, env, {}, siteConfig);
expect(dataA).toEqual({
id: 'ko-version-1.0.0-foo/bar',
language: 'ko',
localized_id: 'ko-version-1.0.0-foo/bar',
permalink: 'docs/ko/1.0.0/foo/bar',
source: 'ko/version-1.0.0/foo/bar.md',
permalink: '/docs/ko/1.0.0/foo/bar',
source: '@translated_docs/ko/version-1.0.0/foo/bar.md',
title: 'Bar',
version: '1.0.0'
});
@ -83,8 +99,8 @@ describe('processMetadata', () => {
id: 'ko-version-1.0.0-hello',
language: 'ko',
localized_id: 'ko-version-1.0.0-hello',
permalink: 'docs/ko/1.0.0/hello',
source: 'ko/version-1.0.0/hello.md',
permalink: '/docs/ko/1.0.0/hello',
source: '@translated_docs/ko/version-1.0.0/hello.md',
title: 'Hello, World !',
version: '1.0.0'
});
@ -92,8 +108,8 @@ describe('processMetadata', () => {
id: 'ko-version-1.0.1-foo/bar',
language: 'ko',
localized_id: 'ko-version-1.0.1-foo/bar',
permalink: 'docs/ko/foo/bar',
source: 'ko/version-1.0.1/foo/bar.md',
permalink: '/docs/ko/foo/bar',
source: '@translated_docs/ko/version-1.0.1/foo/bar.md',
title: 'Bar',
version: '1.0.1'
});
@ -101,8 +117,8 @@ describe('processMetadata', () => {
id: 'ko-version-1.0.1-hello',
language: 'ko',
localized_id: 'ko-version-1.0.1-hello',
permalink: 'docs/ko/hello',
source: 'ko/version-1.0.1/hello.md',
permalink: '/docs/ko/hello',
source: '@translated_docs/ko/version-1.0.1/hello.md',
title: 'Hello, World !',
version: '1.0.1'
});
@ -110,18 +126,18 @@ describe('processMetadata', () => {
test('translated docs only', async () => {
const props = await loadSetup('translated');
const {siteDir, docsDir, env} = props;
const {siteDir, env, siteConfig} = props;
const refDir = path.join(siteDir, 'translated_docs');
const sourceA = path.join('ko', 'foo', 'bar.md');
const sourceB = path.join('ko', 'hello.md');
const dataA = await processMetadata(sourceA, refDir, env, {});
const dataB = await processMetadata(sourceB, refDir, env, {});
const dataA = await processMetadata(sourceA, refDir, env, {}, siteConfig);
const dataB = await processMetadata(sourceB, refDir, env, {}, siteConfig);
expect(dataA).toEqual({
id: 'ko-foo/bar',
language: 'ko',
localized_id: 'ko-foo/bar',
permalink: 'docs/ko/foo/bar',
source: 'ko/foo/bar.md',
permalink: '/docs/ko/foo/bar',
source: '@translated_docs/ko/foo/bar.md',
title: 'Bar',
version: undefined
});
@ -129,8 +145,8 @@ describe('processMetadata', () => {
id: 'ko-hello',
language: 'ko',
localized_id: 'ko-hello',
permalink: 'docs/ko/hello',
source: 'ko/hello.md',
permalink: '/docs/ko/hello',
source: '@translated_docs/ko/hello.md',
title: 'Hello, World !',
version: undefined
});