mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-05 04:12:53 +02:00
feat: allow custom docsUrl & custom permalink
This commit is contained in:
parent
185f7b1ed1
commit
b99605f725
12 changed files with 270 additions and 177 deletions
|
@ -1,10 +1,11 @@
|
|||
module.exports = {
|
||||
title: 'Hello',
|
||||
tagline: 'Hello World',
|
||||
organizationName: 'endiliey',
|
||||
projectName: 'hello',
|
||||
baseUrl: '/',
|
||||
useLessField: 'what',
|
||||
superman: 'lol',
|
||||
admin: 'endi'
|
||||
};
|
||||
module.exports = {
|
||||
title: 'Hello',
|
||||
tagline: 'Hello World',
|
||||
organizationName: 'endiliey',
|
||||
projectName: 'hello',
|
||||
baseUrl: '/',
|
||||
useLessField: 'what',
|
||||
superman: 'lol',
|
||||
admin: 'endi',
|
||||
customFields: ['admin', 'superman']
|
||||
};
|
||||
|
|
|
@ -29,7 +29,7 @@ describe('loadConfig', () => {
|
|||
expect(() => {
|
||||
loadConfig(siteDir);
|
||||
}).toThrowErrorMatchingInlineSnapshot(
|
||||
`"useLessField, superman, admin fields are useless in siteConfig.js"`
|
||||
`"useLessField fields are useless in siteConfig.js"`
|
||||
);
|
||||
});
|
||||
|
||||
|
|
|
@ -6,8 +6,8 @@ Object {
|
|||
"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,
|
||||
},
|
||||
|
@ -15,8 +15,8 @@ Object {
|
|||
"id": "foo/baz",
|
||||
"language": undefined,
|
||||
"localized_id": "foo/baz",
|
||||
"permalink": "docs/foo/baz",
|
||||
"source": "foo/baz.md",
|
||||
"permalink": "/docs/foo/baz",
|
||||
"source": "@docs/foo/baz.md",
|
||||
"title": "baz",
|
||||
"version": undefined,
|
||||
},
|
||||
|
@ -24,11 +24,20 @@ Object {
|
|||
"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,
|
||||
},
|
||||
"permalink": Object {
|
||||
"id": "permalink",
|
||||
"language": undefined,
|
||||
"localized_id": "permalink",
|
||||
"permalink": "/docs/endiliey/permalink",
|
||||
"source": "@docs/permalink.md",
|
||||
"title": "Permalink",
|
||||
"version": undefined,
|
||||
},
|
||||
}
|
||||
`;
|
||||
|
||||
|
@ -38,8 +47,8 @@ Object {
|
|||
"id": "en-foo/bar",
|
||||
"language": "en",
|
||||
"localized_id": "en-foo/bar",
|
||||
"permalink": "docs/en/foo/bar",
|
||||
"source": "foo/bar.md",
|
||||
"permalink": "/docs/en/foo/bar",
|
||||
"source": "@docs/foo/bar.md",
|
||||
"title": "Bar",
|
||||
"version": undefined,
|
||||
},
|
||||
|
@ -47,8 +56,8 @@ Object {
|
|||
"id": "en-foo/baz",
|
||||
"language": "en",
|
||||
"localized_id": "en-foo/baz",
|
||||
"permalink": "docs/en/foo/baz",
|
||||
"source": "foo/baz.md",
|
||||
"permalink": "/docs/en/foo/baz",
|
||||
"source": "@docs/foo/baz.md",
|
||||
"title": "baz",
|
||||
"version": undefined,
|
||||
},
|
||||
|
@ -56,17 +65,26 @@ Object {
|
|||
"id": "en-hello",
|
||||
"language": "en",
|
||||
"localized_id": "en-hello",
|
||||
"permalink": "docs/en/hello",
|
||||
"source": "hello.md",
|
||||
"permalink": "/docs/en/hello",
|
||||
"source": "@docs/hello.md",
|
||||
"title": "Hello, World !",
|
||||
"version": undefined,
|
||||
},
|
||||
"en-permalink": Object {
|
||||
"id": "en-permalink",
|
||||
"language": "en",
|
||||
"localized_id": "en-permalink",
|
||||
"permalink": "/docs/en/endiliey/permalink",
|
||||
"source": "@docs/permalink.md",
|
||||
"title": "Permalink",
|
||||
"version": undefined,
|
||||
},
|
||||
"ko-foo/bar": Object {
|
||||
"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,
|
||||
},
|
||||
|
@ -74,8 +92,8 @@ Object {
|
|||
"id": "ko-foo/baz",
|
||||
"language": "ko",
|
||||
"localized_id": "ko-foo/baz",
|
||||
"permalink": "docs/ko/foo/baz",
|
||||
"source": "ko/foo/baz.md",
|
||||
"permalink": "/docs/ko/foo/baz",
|
||||
"source": "@translated_docs/ko/foo/baz.md",
|
||||
"title": "baz",
|
||||
"version": undefined,
|
||||
},
|
||||
|
@ -83,8 +101,8 @@ Object {
|
|||
"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,
|
||||
},
|
||||
|
@ -97,8 +115,8 @@ Object {
|
|||
"id": "en-foo/bar",
|
||||
"language": "en",
|
||||
"localized_id": "en-foo/bar",
|
||||
"permalink": "docs/en/next/foo/bar",
|
||||
"source": "foo/bar.md",
|
||||
"permalink": "/docs/en/next/foo/bar",
|
||||
"source": "@docs/foo/bar.md",
|
||||
"title": "Bar",
|
||||
"version": "next",
|
||||
},
|
||||
|
@ -106,8 +124,8 @@ Object {
|
|||
"id": "en-foo/baz",
|
||||
"language": "en",
|
||||
"localized_id": "en-foo/baz",
|
||||
"permalink": "docs/en/next/foo/baz",
|
||||
"source": "foo/baz.md",
|
||||
"permalink": "/docs/en/next/foo/baz",
|
||||
"source": "@docs/foo/baz.md",
|
||||
"title": "baz",
|
||||
"version": "next",
|
||||
},
|
||||
|
@ -115,17 +133,26 @@ Object {
|
|||
"id": "en-hello",
|
||||
"language": "en",
|
||||
"localized_id": "en-hello",
|
||||
"permalink": "docs/en/next/hello",
|
||||
"source": "hello.md",
|
||||
"permalink": "/docs/en/next/hello",
|
||||
"source": "@docs/hello.md",
|
||||
"title": "Hello, World !",
|
||||
"version": "next",
|
||||
},
|
||||
"en-permalink": Object {
|
||||
"id": "en-permalink",
|
||||
"language": "en",
|
||||
"localized_id": "en-permalink",
|
||||
"permalink": "/docs/en/next/endiliey/permalink",
|
||||
"source": "@docs/permalink.md",
|
||||
"title": "Permalink",
|
||||
"version": "next",
|
||||
},
|
||||
"en-version-1.0.0-foo/bar": Object {
|
||||
"id": "en-version-1.0.0-foo/bar",
|
||||
"language": "en",
|
||||
"localized_id": "en-version-1.0.0-foo/bar",
|
||||
"permalink": "docs/en/1.0.0/foo/bar",
|
||||
"source": "version-1.0.0/foo/bar.md",
|
||||
"permalink": "/docs/en/1.0.0/foo/bar",
|
||||
"source": "@versioned_docs/version-1.0.0/foo/bar.md",
|
||||
"title": "Bar",
|
||||
"version": "1.0.0",
|
||||
},
|
||||
|
@ -133,8 +160,8 @@ Object {
|
|||
"id": "en-version-1.0.0-foo/baz",
|
||||
"language": "en",
|
||||
"localized_id": "en-version-1.0.0-foo/baz",
|
||||
"permalink": "docs/en/1.0.0/foo/baz",
|
||||
"source": "version-1.0.0/foo/baz.md",
|
||||
"permalink": "/docs/en/1.0.0/foo/baz",
|
||||
"source": "@versioned_docs/version-1.0.0/foo/baz.md",
|
||||
"title": "Baz",
|
||||
"version": "1.0.0",
|
||||
},
|
||||
|
@ -142,8 +169,8 @@ Object {
|
|||
"id": "en-version-1.0.0-hello",
|
||||
"language": "en",
|
||||
"localized_id": "en-version-1.0.0-hello",
|
||||
"permalink": "docs/en/1.0.0/hello",
|
||||
"source": "version-1.0.0/hello.md",
|
||||
"permalink": "/docs/en/1.0.0/hello",
|
||||
"source": "@versioned_docs/version-1.0.0/hello.md",
|
||||
"title": "Hello, World !",
|
||||
"version": "1.0.0",
|
||||
},
|
||||
|
@ -151,8 +178,8 @@ Object {
|
|||
"id": "en-version-1.0.1-foo/bar",
|
||||
"language": "en",
|
||||
"localized_id": "en-version-1.0.1-foo/bar",
|
||||
"permalink": "docs/en/foo/bar",
|
||||
"source": "version-1.0.1/foo/bar.md",
|
||||
"permalink": "/docs/en/foo/bar",
|
||||
"source": "@versioned_docs/version-1.0.1/foo/bar.md",
|
||||
"title": "Bar",
|
||||
"version": "1.0.1",
|
||||
},
|
||||
|
@ -160,8 +187,8 @@ Object {
|
|||
"id": "en-version-1.0.1-foo/baz",
|
||||
"language": "en",
|
||||
"localized_id": "en-version-1.0.1-foo/baz",
|
||||
"permalink": "docs/en/foo/baz",
|
||||
"source": "version-1.0.1/foo/baz.md",
|
||||
"permalink": "/docs/en/foo/baz",
|
||||
"source": "@versioned_docs/version-1.0.1/foo/baz.md",
|
||||
"title": "Baz",
|
||||
"version": "1.0.1",
|
||||
},
|
||||
|
@ -169,8 +196,8 @@ Object {
|
|||
"id": "en-version-1.0.1-hello",
|
||||
"language": "en",
|
||||
"localized_id": "en-version-1.0.1-hello",
|
||||
"permalink": "docs/en/hello",
|
||||
"source": "version-1.0.1/hello.md",
|
||||
"permalink": "/docs/en/hello",
|
||||
"source": "@versioned_docs/version-1.0.1/hello.md",
|
||||
"title": "Hello, World !",
|
||||
"version": "1.0.1",
|
||||
},
|
||||
|
@ -178,8 +205,8 @@ Object {
|
|||
"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",
|
||||
},
|
||||
|
@ -187,8 +214,8 @@ Object {
|
|||
"id": "ko-version-1.0.0-foo/baz",
|
||||
"language": "ko",
|
||||
"localized_id": "ko-version-1.0.0-foo/baz",
|
||||
"permalink": "docs/ko/1.0.0/foo/baz",
|
||||
"source": "ko/version-1.0.0/foo/baz.md",
|
||||
"permalink": "/docs/ko/1.0.0/foo/baz",
|
||||
"source": "@translated_docs/ko/version-1.0.0/foo/baz.md",
|
||||
"title": "baz",
|
||||
"version": "1.0.0",
|
||||
},
|
||||
|
@ -196,8 +223,8 @@ Object {
|
|||
"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",
|
||||
},
|
||||
|
@ -205,8 +232,8 @@ Object {
|
|||
"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",
|
||||
},
|
||||
|
@ -214,8 +241,8 @@ Object {
|
|||
"id": "ko-version-1.0.1-foo/baz",
|
||||
"language": "ko",
|
||||
"localized_id": "ko-version-1.0.1-foo/baz",
|
||||
"permalink": "docs/ko/foo/baz",
|
||||
"source": "ko/version-1.0.1/foo/baz.md",
|
||||
"permalink": "/docs/ko/foo/baz",
|
||||
"source": "@translated_docs/ko/version-1.0.1/foo/baz.md",
|
||||
"title": "baz",
|
||||
"version": "1.0.1",
|
||||
},
|
||||
|
@ -223,8 +250,8 @@ Object {
|
|||
"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",
|
||||
},
|
||||
|
@ -237,8 +264,8 @@ Object {
|
|||
"id": "foo/bar",
|
||||
"language": undefined,
|
||||
"localized_id": "foo/bar",
|
||||
"permalink": "docs/next/foo/bar",
|
||||
"source": "foo/bar.md",
|
||||
"permalink": "/docs/next/foo/bar",
|
||||
"source": "@docs/foo/bar.md",
|
||||
"title": "Bar",
|
||||
"version": "next",
|
||||
},
|
||||
|
@ -246,8 +273,8 @@ Object {
|
|||
"id": "foo/baz",
|
||||
"language": undefined,
|
||||
"localized_id": "foo/baz",
|
||||
"permalink": "docs/next/foo/baz",
|
||||
"source": "foo/baz.md",
|
||||
"permalink": "/docs/next/foo/baz",
|
||||
"source": "@docs/foo/baz.md",
|
||||
"title": "baz",
|
||||
"version": "next",
|
||||
},
|
||||
|
@ -255,11 +282,20 @@ Object {
|
|||
"id": "hello",
|
||||
"language": undefined,
|
||||
"localized_id": "hello",
|
||||
"permalink": "docs/next/hello",
|
||||
"source": "hello.md",
|
||||
"permalink": "/docs/next/hello",
|
||||
"source": "@docs/hello.md",
|
||||
"title": "Hello, World !",
|
||||
"version": "next",
|
||||
},
|
||||
"permalink": Object {
|
||||
"id": "permalink",
|
||||
"language": undefined,
|
||||
"localized_id": "permalink",
|
||||
"permalink": "/docs/next/endiliey/permalink",
|
||||
"source": "@docs/permalink.md",
|
||||
"title": "Permalink",
|
||||
"version": "next",
|
||||
},
|
||||
"version-1.0.0-foo/bar": Object {
|
||||
"category": "Test",
|
||||
"id": "version-1.0.0-foo/bar",
|
||||
|
@ -268,9 +304,9 @@ Object {
|
|||
"next": "version-1.0.0-foo/baz",
|
||||
"next_id": "version-1.0.0-foo/baz",
|
||||
"next_title": "Baz",
|
||||
"permalink": "docs/1.0.0/foo/bar",
|
||||
"permalink": "/docs/1.0.0/foo/bar",
|
||||
"sidebar": "version-1.0.0-docs",
|
||||
"source": "version-1.0.0/foo/bar.md",
|
||||
"source": "@versioned_docs/version-1.0.0/foo/bar.md",
|
||||
"title": "Bar",
|
||||
"version": "1.0.0",
|
||||
},
|
||||
|
@ -282,12 +318,12 @@ Object {
|
|||
"next": "version-1.0.0-hello",
|
||||
"next_id": "version-1.0.0-hello",
|
||||
"next_title": "Hello, World !",
|
||||
"permalink": "docs/1.0.0/foo/baz",
|
||||
"permalink": "/docs/1.0.0/foo/baz",
|
||||
"previous": "version-1.0.0-foo/bar",
|
||||
"previous_id": "version-1.0.0-foo/bar",
|
||||
"previous_title": "Bar",
|
||||
"sidebar": "version-1.0.0-docs",
|
||||
"source": "version-1.0.0/foo/baz.md",
|
||||
"source": "@versioned_docs/version-1.0.0/foo/baz.md",
|
||||
"title": "Baz",
|
||||
"version": "1.0.0",
|
||||
},
|
||||
|
@ -296,12 +332,12 @@ Object {
|
|||
"id": "version-1.0.0-hello",
|
||||
"language": undefined,
|
||||
"localized_id": "version-1.0.0-hello",
|
||||
"permalink": "docs/1.0.0/hello",
|
||||
"permalink": "/docs/1.0.0/hello",
|
||||
"previous": "version-1.0.0-foo/baz",
|
||||
"previous_id": "version-1.0.0-foo/baz",
|
||||
"previous_title": "Baz",
|
||||
"sidebar": "version-1.0.0-docs",
|
||||
"source": "version-1.0.0/hello.md",
|
||||
"source": "@versioned_docs/version-1.0.0/hello.md",
|
||||
"title": "Hello, World !",
|
||||
"version": "1.0.0",
|
||||
},
|
||||
|
@ -313,9 +349,9 @@ Object {
|
|||
"next": "version-1.0.1-foo/baz",
|
||||
"next_id": "version-1.0.1-foo/baz",
|
||||
"next_title": "Baz",
|
||||
"permalink": "docs/foo/bar",
|
||||
"permalink": "/docs/foo/bar",
|
||||
"sidebar": "version-1.0.1-docs",
|
||||
"source": "version-1.0.1/foo/bar.md",
|
||||
"source": "@versioned_docs/version-1.0.1/foo/bar.md",
|
||||
"title": "Bar",
|
||||
"version": "1.0.1",
|
||||
},
|
||||
|
@ -327,12 +363,12 @@ Object {
|
|||
"next": "version-1.0.1-hello",
|
||||
"next_id": "version-1.0.1-hello",
|
||||
"next_title": "Hello, World !",
|
||||
"permalink": "docs/foo/baz",
|
||||
"permalink": "/docs/foo/baz",
|
||||
"previous": "version-1.0.1-foo/bar",
|
||||
"previous_id": "version-1.0.1-foo/bar",
|
||||
"previous_title": "Bar",
|
||||
"sidebar": "version-1.0.1-docs",
|
||||
"source": "version-1.0.1/foo/baz.md",
|
||||
"source": "@versioned_docs/version-1.0.1/foo/baz.md",
|
||||
"title": "Baz",
|
||||
"version": "1.0.1",
|
||||
},
|
||||
|
@ -341,12 +377,12 @@ Object {
|
|||
"id": "version-1.0.1-hello",
|
||||
"language": undefined,
|
||||
"localized_id": "version-1.0.1-hello",
|
||||
"permalink": "docs/hello",
|
||||
"permalink": "/docs/hello",
|
||||
"previous": "version-1.0.1-foo/baz",
|
||||
"previous_id": "version-1.0.1-foo/baz",
|
||||
"previous_title": "Baz",
|
||||
"sidebar": "version-1.0.1-docs",
|
||||
"source": "version-1.0.1/hello.md",
|
||||
"source": "@versioned_docs/version-1.0.1/hello.md",
|
||||
"title": "Hello, World !",
|
||||
"version": "1.0.1",
|
||||
},
|
||||
|
|
|
@ -4,29 +4,29 @@ import loadSetup from '../../loadSetup';
|
|||
describe('loadDocs', () => {
|
||||
test('simple website', async () => {
|
||||
const props = await loadSetup('simple');
|
||||
const {siteDir, docsDir, env} = props;
|
||||
const docsData = await loadDocs({siteDir, docsDir, env});
|
||||
const {siteDir, docsDir, env, siteConfig} = props;
|
||||
const docsData = await loadDocs({siteDir, docsDir, env, siteConfig});
|
||||
expect(docsData).toMatchSnapshot();
|
||||
});
|
||||
|
||||
test('versioned website', async () => {
|
||||
const props = await loadSetup('versioned');
|
||||
const {siteDir, docsDir, env} = props;
|
||||
const docsData = await loadDocs({siteDir, docsDir, env});
|
||||
const {siteDir, docsDir, env, siteConfig} = props;
|
||||
const docsData = await loadDocs({siteDir, docsDir, env, siteConfig});
|
||||
expect(docsData).toMatchSnapshot();
|
||||
});
|
||||
|
||||
test('versioned & translated website', async () => {
|
||||
const props = await loadSetup('transversioned');
|
||||
const {siteDir, docsDir, env} = props;
|
||||
const docsData = await loadDocs({siteDir, docsDir, env});
|
||||
const {siteDir, docsDir, env, siteConfig} = props;
|
||||
const docsData = await loadDocs({siteDir, docsDir, env, siteConfig});
|
||||
expect(docsData).toMatchSnapshot();
|
||||
});
|
||||
|
||||
test('translated website', async () => {
|
||||
const props = await loadSetup('translated');
|
||||
const {siteDir, docsDir, env} = props;
|
||||
const docsData = await loadDocs({siteDir, docsDir, env});
|
||||
const {siteDir, docsDir, env, siteConfig} = props;
|
||||
const docsData = await loadDocs({siteDir, docsDir, env, siteConfig});
|
||||
expect(docsData).toMatchSnapshot();
|
||||
});
|
||||
});
|
||||
|
|
|
@ -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
|
||||
});
|
||||
|
|
|
@ -4,7 +4,7 @@ import path from 'path';
|
|||
describe('loadPages', () => {
|
||||
test('valid pages', async () => {
|
||||
const pagesDir = path.join(__dirname, '__fixtures__', 'simple-pages');
|
||||
let pagesData = await loadPages(pagesDir);
|
||||
const pagesData = await loadPages(pagesDir);
|
||||
pagesData.sort((a, b) => a.path > b.path); // because it was unordered
|
||||
expect(pagesData).toEqual([
|
||||
{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue