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

feat: new docs options: versions.{badge,className} (#5454)

Browse source 
* docs: add versions.{badge,className} options

* remove badge option test
This commit is contained in:
Sébastien Lorber 2021-08-31 15:40:37 +02:00 • committed by GitHub
parent 914e204dcb
commit 42e70e6d42
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 93 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -515,6 +515,8 @@ Object {
\\"version\\": \\"current\\",
\\"label\\": \\"Next\\",
\\"banner\\": \\"none\\",
\\"badge\\": false,
\\"className\\": \\"docs-version-current\\",
\\"isLast\\": true,
\\"docsSidebars\\": {
\\"docs\\": [
@ -1024,6 +1026,8 @@ Object {
\\"version\\": \\"1.0.0\\",
\\"label\\": \\"1.0.0\\",
\\"banner\\": \\"none\\",
\\"badge\\": true,
\\"className\\": \\"docs-version-1.0.0\\",
\\"isLast\\": true,
\\"docsSidebars\\": {
\\"version-1.0.0/community\\": [
@ -1040,6 +1044,8 @@ Object {
\\"version\\": \\"current\\",
\\"label\\": \\"Next\\",
\\"banner\\": \\"unreleased\\",
\\"badge\\": true,
\\"className\\": \\"docs-version-current\\",
\\"isLast\\": false,
\\"docsSidebars\\": {
\\"community\\": [
@ -1673,6 +1679,8 @@ Object {
\\"version\\": \\"1.0.0\\",
\\"label\\": \\"1.0.0\\",
\\"banner\\": \\"unmaintained\\",
\\"badge\\": true,
\\"className\\": \\"docs-version-1.0.0\\",
\\"isLast\\": false,
\\"docsSidebars\\": {
\\"version-1.0.0/docs\\": [
@ -1715,6 +1723,8 @@ Object {
\\"version\\": \\"1.0.1\\",
\\"label\\": \\"1.0.1\\",
\\"banner\\": \\"none\\",
\\"badge\\": true,
\\"className\\": \\"docs-version-1.0.1\\",
\\"isLast\\": true,
\\"docsSidebars\\": {
\\"version-1.0.1/docs\\": [
@ -1752,6 +1762,8 @@ Object {
\\"version\\": \\"current\\",
\\"label\\": \\"Next\\",
\\"banner\\": \\"unreleased\\",
\\"badge\\": true,
\\"className\\": \\"docs-version-current\\",
\\"isLast\\": false,
\\"docsSidebars\\": {
\\"docs\\": [
@ -1789,6 +1801,8 @@ Object {
\\"version\\": \\"withSlugs\\",
\\"label\\": \\"withSlugs\\",
\\"banner\\": \\"unmaintained\\",
\\"badge\\": true,
\\"className\\": \\"docs-version-withSlugs\\",
\\"isLast\\": false,
\\"docsSidebars\\": {
\\"version-1.0.1/docs\\": [

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

@ -82,6 +82,8 @@ describe('simple site', () => {
versionName: 'current',
versionPath: '/docs',
versionBanner: 'none',
versionBadge: false,
versionClassName: 'docs-version-current',
};
return {simpleSiteDir, defaultOptions, defaultContext, vCurrent};
}
@ -240,6 +242,8 @@ describe('versioned site, pluginId=default', () => {
versionName: 'current',
versionPath: '/docs/next',
versionBanner: 'unreleased',
versionBadge: true,
versionClassName: 'docs-version-current',
};
const v101: VersionMetadata = {
@ -259,6 +263,8 @@ describe('versioned site, pluginId=default', () => {
versionName: '1.0.1',
versionPath: '/docs',
versionBanner: 'none',
versionBadge: true,
versionClassName: 'docs-version-1.0.1',
};
const v100: VersionMetadata = {
@ -278,6 +284,8 @@ describe('versioned site, pluginId=default', () => {
versionName: '1.0.0',
versionPath: '/docs/1.0.0',
versionBanner: 'unmaintained',
versionBadge: true,
versionClassName: 'docs-version-1.0.0',
};
const vwithSlugs: VersionMetadata = {
@ -300,6 +308,8 @@ describe('versioned site, pluginId=default', () => {
versionName: 'withSlugs',
versionPath: '/docs/withSlugs',
versionBanner: 'unmaintained',
versionBadge: true,
versionClassName: 'docs-version-withSlugs',
};
return {
@ -371,6 +381,8 @@ describe('versioned site, pluginId=default', () => {
current: {
path: 'current-path',
banner: 'unmaintained',
badge: false,
className: 'custom-current-className',
},
'1.0.0': {
label: '1.0.0-label',
@ -387,6 +399,8 @@ describe('versioned site, pluginId=default', () => {
tagsPath: '/docs/current-path/tags',
versionPath: '/docs/current-path',
versionBanner: 'unmaintained',
versionBadge: false,
versionClassName: 'custom-current-className',
},
{
...v101,
@ -541,6 +555,7 @@ describe('versioned site, pluginId=default', () => {
tagsPath: '/docs/tags',
versionPath: '/docs',
versionBanner: 'none',
versionBadge: false,
},
]);
});
@ -664,6 +679,8 @@ describe('versioned site, pluginId=community', () => {
versionName: 'current',
versionPath: '/communityBasePath/next',
versionBanner: 'unreleased',
versionBadge: true,
versionClassName: 'docs-version-current',
};
const v100: VersionMetadata = {
@ -686,6 +703,8 @@ describe('versioned site, pluginId=community', () => {
versionName: '1.0.0',
versionPath: '/communityBasePath',
versionBanner: 'none',
versionBadge: true,
versionClassName: 'docs-version-1.0.0',
};
return {versionedSiteDir, defaultOptions, defaultContext, vCurrent, v100};
@ -712,7 +731,7 @@ describe('versioned site, pluginId=community', () => {
expect(versionsMetadata).toEqual([
// vCurrent removed
v100,
{...v100, versionBadge: false},
]);
});
@ -732,6 +751,7 @@ describe('versioned site, pluginId=community', () => {
tagsPath: '/communityBasePath/tags',
versionPath: '/communityBasePath',
versionBanner: 'none',
versionBadge: false,
},
]);
});