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

feat(v2): docs version banner configuration option (#5052)

Browse source 
* refactor DocVersionBanner => versionMetadata prop should be forwarded instead of using "useActiveVersion" + global data

* docs version banner configuration

* add doc for versions.banner

* fix tests

* improve docs plugin option api doc
This commit is contained in:
Sébastien Lorber 2021-06-24 18:04:16 +02:00 • committed by GitHub
parent f47826297c
commit 364051f232
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 187 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

27
packages/docusaurus-plugin-content-docs/src/__tests__/versions.test.ts
View file

@ -21,6 +21,7 @@ const DefaultI18N: I18n = {
currentLocale: 'en',
locales: ['en'],
defaultLocale: 'en',
localeConfigs: {},
};
describe('version paths', () => {
@ -79,6 +80,7 @@ describe('simple site', () => {
versionLabel: 'Next',
versionName: 'current',
versionPath: '/docs',
versionBanner: 'none',
};
return {simpleSiteDir, defaultOptions, defaultContext, vCurrent};
}
@ -233,6 +235,7 @@ describe('versioned site, pluginId=default', () => {
versionLabel: 'Next',
versionName: 'current',
versionPath: '/docs/next',
versionBanner: 'unreleased',
};
const v101: VersionMetadata = {
@ -250,6 +253,7 @@ describe('versioned site, pluginId=default', () => {
versionLabel: '1.0.1',
versionName: '1.0.1',
versionPath: '/docs',
versionBanner: 'none',
};
const v100: VersionMetadata = {
@ -267,6 +271,7 @@ describe('versioned site, pluginId=default', () => {
versionLabel: '1.0.0',
versionName: '1.0.0',
versionPath: '/docs/1.0.0',
versionBanner: 'unmaintained',
};
const vwithSlugs: VersionMetadata = {
@ -287,6 +292,7 @@ describe('versioned site, pluginId=default', () => {
versionLabel: 'withSlugs',
versionName: 'withSlugs',
versionPath: '/docs/withSlugs',
versionBanner: 'unmaintained',
};
return {
@ -357,9 +363,11 @@ describe('versioned site, pluginId=default', () => {
versions: {
current: {
path: 'current-path',
banner: 'unmaintained',
},
'1.0.0': {
label: '1.0.0-label',
banner: 'unreleased',
},
},
},
@ -367,12 +375,17 @@ describe('versioned site, pluginId=default', () => {
});
expect(versionsMetadata).toEqual([
{...vCurrent, versionPath: '/docs/current-path'},
{
...vCurrent,
versionPath: '/docs/current-path',
versionBanner: 'unmaintained',
},
{
...v101,
isLast: false,
routePriority: undefined,
versionPath: '/docs/1.0.1',
versionBanner: 'unreleased',
},
{
...v100,
@ -380,6 +393,7 @@ describe('versioned site, pluginId=default', () => {
routePriority: -1,
versionLabel: '1.0.0-label',
versionPath: '/docs',
versionBanner: 'unreleased',
},
vwithSlugs,
]);
@ -510,7 +524,13 @@ describe('versioned site, pluginId=default', () => {
});
expect(versionsMetadata).toEqual([
{...vCurrent, isLast: true, routePriority: -1, versionPath: '/docs'},
{
...vCurrent,
isLast: true,
routePriority: -1,
versionPath: '/docs',
versionBanner: 'none',
},
]);
});
@ -631,6 +651,7 @@ describe('versioned site, pluginId=community', () => {
versionLabel: 'Next',
versionName: 'current',
versionPath: '/communityBasePath/next',
versionBanner: 'unreleased',
};
const v100: VersionMetadata = {
@ -651,6 +672,7 @@ describe('versioned site, pluginId=community', () => {
versionLabel: '1.0.0',
versionName: '1.0.0',
versionPath: '/communityBasePath',
versionBanner: 'none',
};
return {versionedSiteDir, defaultOptions, defaultContext, vCurrent, v100};
@ -695,6 +717,7 @@ describe('versioned site, pluginId=community', () => {
isLast: true,
routePriority: -1,
versionPath: '/communityBasePath',
versionBanner: 'none',
},
]);
});