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

feat(v2): docs plugin initial work (#1327)

Browse source 
* feat(v2): pluginify docs

* feat(v2): implement docs plugin

* fix(v2): fix bugs in docs plugin for translation and versioning
This commit is contained in:
Yangshun Tay 2019-03-31 11:37:35 -07:00 • committed by GitHub
parent c33e874e1c
commit a70d9b6720
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
32 changed files with 576 additions and 371 deletions
Download patch file Download diff file Expand all files Collapse all files

257
packages/docusaurus-plugin-content-docs/__tests__/index.test.js Normal file
View file

@ -0,0 +1,257 @@
/**
* Copyright (c) 2017-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import '@babel/polyfill';
import path from 'path';
import loadSetup from '../../docusaurus/test/loadSetup';
import DocusaurusPluginContentDocs from '../index';
describe('loadDocs', () => {
test.only('simple website', async () => {
const {env, siteDir, siteConfig} = await loadSetup('simple');
const plugin = new DocusaurusPluginContentDocs(
{
path: '../docs',
},
{
env,
siteDir,
siteConfig,
},
);
const {docs: docsMetadata} = await plugin.loadContent();
const docsDir = plugin.contentPath;
expect(docsMetadata.hello).toEqual({
category: 'Guides',
id: 'hello',
language: null,
localized_id: 'hello',
permalink: '/docs/hello',
previous: 'foo/baz',
previous_id: 'foo/baz',
previous_title: 'baz',
sidebar: 'docs',
source: path.join(docsDir, 'hello.md'),
title: 'Hello, World !',
version: null,
});
expect(docsMetadata['foo/bar']).toEqual({
category: 'Test',
id: 'foo/bar',
language: null,
localized_id: 'foo/bar',
next: 'foo/baz',
next_id: 'foo/baz',
next_title: 'baz',
permalink: '/docs/foo/bar',
sidebar: 'docs',
source: path.join(docsDir, 'foo', 'bar.md'),
title: 'Bar',
version: null,
});
});
test('versioned website', async () => {
const {env, siteDir, siteConfig, versionedDir} = await loadSetup(
'versioned',
);
const plugin = new DocusaurusPluginContentDocs(
{
path: '../docs',
},
{
env,
siteDir,
siteConfig,
},
);
const {docs: docsMetadata} = await plugin.loadContent();
const docsDir = plugin.contentPath;
expect(docsMetadata['version-1.0.0-foo/bar']).toEqual({
category: 'Test',
id: 'version-1.0.0-foo/bar',
language: null,
localized_id: 'version-1.0.0-foo/bar',
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',
sidebar: 'version-1.0.0-docs',
source: path.join(versionedDir, 'version-1.0.0/foo/bar.md'),
title: 'Bar',
version: '1.0.0',
});
expect(docsMetadata['foo/bar']).toEqual({
category: 'Test',
id: 'foo/bar',
language: null,
localized_id: 'foo/bar',
next: 'foo/baz',
next_id: 'foo/baz',
next_title: 'baz',
permalink: '/docs/next/foo/bar',
sidebar: 'docs',
source: path.join(docsDir, 'foo/bar.md'),
title: 'Bar',
version: 'next',
});
});
test('versioned & translated website', async () => {
const {
env,
siteDir,
siteConfig,
translatedDir,
versionedDir,
} = await loadSetup('transversioned');
const plugin = new DocusaurusPluginContentDocs(
{
path: '../docs',
},
{
env,
siteDir,
siteConfig,
},
);
const {docs: docsMetadata} = await plugin.loadContent();
const docsDir = plugin.contentPath;
expect(docsMetadata['ko-version-1.0.0-foo/bar']).toEqual({
category: 'Test',
id: 'ko-version-1.0.0-foo/bar',
language: 'ko',
localized_id: 'version-1.0.0-foo/bar',
next: 'ko-version-1.0.0-foo/baz',
next_id: 'version-1.0.0-foo/baz',
next_title: 'baz',
permalink: '/docs/ko/1.0.0/foo/bar',
sidebar: 'version-1.0.0-docs',
source: path.join(translatedDir, '/ko/version-1.0.0/foo/bar.md'),
title: 'Bar',
version: '1.0.0',
});
expect(docsMetadata['en-version-1.0.0-foo/baz']).toEqual({
category: 'Test',
id: 'en-version-1.0.0-foo/baz',
language: 'en',
localized_id: 'version-1.0.0-foo/baz',
next: 'en-version-1.0.0-hello',
next_id: 'version-1.0.0-hello',
next_title: 'Hello, World !',
permalink: '/docs/en/1.0.0/foo/baz',
previous: 'en-version-1.0.0-foo/bar',
previous_id: 'version-1.0.0-foo/bar',
previous_title: 'Bar',
sidebar: 'version-1.0.0-docs',
source: path.join(versionedDir, 'version-1.0.0/foo/baz.md'),
title: 'Baz',
version: '1.0.0',
});
expect(docsMetadata['en-hello']).toEqual({
category: 'Guides',
id: 'en-hello',
language: 'en',
localized_id: 'hello',
permalink: '/docs/en/next/hello',
previous: 'en-foo/baz',
previous_id: 'foo/baz',
previous_title: 'baz',
sidebar: 'docs',
source: path.join(docsDir, 'hello.md'),
title: 'Hello, World !',
version: 'next',
});
});
test('translated website', async () => {
const {env, siteDir, siteConfig, translatedDir} = await loadSetup(
'translated',
);
const plugin = new DocusaurusPluginContentDocs(
{
path: '../docs',
},
{
env,
siteDir,
siteConfig,
},
);
const {docs: docsMetadata} = await plugin.loadContent();
const docsDir = plugin.contentPath;
expect(docsMetadata['ko-foo/baz']).toEqual({
category: 'Test',
id: 'ko-foo/baz',
language: 'ko',
localized_id: 'foo/baz',
next: 'ko-hello',
next_id: 'hello',
next_title: 'Hello, World !',
permalink: '/docs/ko/foo/baz',
previous: 'ko-foo/bar',
previous_id: 'foo/bar',
previous_title: 'Bar',
sidebar: 'docs',
source: path.join(translatedDir, 'ko', 'foo', 'baz.md'),
title: 'baz',
version: null,
});
expect(docsMetadata['en-foo/bar']).toEqual({
category: 'Test',
id: 'en-foo/bar',
language: 'en',
localized_id: 'foo/bar',
next: 'en-foo/baz',
next_id: 'foo/baz',
next_title: 'baz',
permalink: '/docs/en/foo/bar',
sidebar: 'docs',
source: path.join(docsDir, 'foo', 'bar.md'),
title: 'Bar',
version: null,
});
});
test('versioned website with skip next release', async () => {
const {env, siteDir, siteConfig, versionedDir} = await loadSetup(
'versioned',
);
const plugin = new DocusaurusPluginContentDocs(
{
path: '../docs',
},
{
env,
siteDir,
siteConfig,
cliOptions: {skipNextRelease: true},
},
);
const {docs: docsMetadata} = await plugin.loadContent();
expect(docsMetadata['version-1.0.0-foo/bar']).toEqual({
category: 'Test',
id: 'version-1.0.0-foo/bar',
language: null,
localized_id: 'version-1.0.0-foo/bar',
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',
sidebar: 'version-1.0.0-docs',
source: path.join(versionedDir, 'version-1.0.0/foo/bar.md'),
title: 'Bar',
version: '1.0.0',
});
expect(docsMetadata['foo/bar']).toBeUndefined();
});
});