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

fix(v2): sidebar_label should be used to compute next/previous button labels (#4970)

Browse source 
* sidebar_label should be used to compute next/previous button texts, as documented.

* improve docs frontmatter doc

* use a little bit of destructuring
This commit is contained in:
Sébastien Lorber 2021-06-15 12:04:29 +02:00 • committed by GitHub
parent aeb8e9da51
commit 737f80a026
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 75 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

1
packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/hello.md
View file

@ -1,6 +1,7 @@
---
id: hello
title: Hello, World !
sidebar_label: Hello sidebar_label
---
Hi, Endilie here :)

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

@ -208,7 +208,7 @@ Object {
\\"permalink\\": \\"/docs/foo/bar\\"
},
\\"next\\": {
\\"title\\": \\"Hello, World !\\",
\\"title\\": \\"Hello sidebar_label\\",
\\"permalink\\": \\"/docs/\\"
}
}",
@ -238,7 +238,8 @@ Object {
\\"version\\": \\"current\\",
\\"frontMatter\\": {
\\"id\\": \\"hello\\",
\\"title\\": \\"Hello, World !\\"
\\"title\\": \\"Hello, World !\\",
\\"sidebar_label\\": \\"Hello sidebar_label\\"
},
\\"sidebar\\": \\"docs\\",
\\"previous\\": {
@ -435,7 +436,7 @@ Object {
},
{
\\"type\\": \\"link\\",
\\"label\\": \\"Hello, World !\\",
\\"label\\": \\"Hello sidebar_label\\",
\\"href\\": \\"/docs/\\"
}
]
@ -447,7 +448,7 @@ Object {
\\"items\\": [
{
\\"type\\": \\"link\\",
\\"label\\": \\"Hello, World !\\",
\\"label\\": \\"Hello sidebar_label\\",
\\"href\\": \\"/docs/\\"
}
]

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

@ -201,6 +201,7 @@ describe('simple site', () => {
frontMatter: {
id: 'hello',
title: 'Hello, World !',
sidebar_label: 'Hello sidebar_label',
},
});
});
@ -230,6 +231,7 @@ describe('simple site', () => {
frontMatter: {
id: 'hello',
title: 'Hello, World !',
sidebar_label: 'Hello sidebar_label',
},
});
});

34
packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
View file

@ -328,6 +328,39 @@ describe('simple website', () => {
expect(content.loadedVersions.length).toEqual(1);
const [currentVersion] = content.loadedVersions;
expect(findDocById(currentVersion, 'foo/baz')).toEqual({
...defaultDocMetadata,
version: 'current',
id: 'foo/baz',
unversionedId: 'foo/baz',
sourceDirName: 'foo',
isDocsHomePage: false,
permalink: '/docs/foo/bazSlug.html',
slug: '/foo/bazSlug.html',
previous: {
title: 'Bar',
permalink: '/docs/foo/bar',
},
next: {
title: 'Hello sidebar_label',
permalink: '/docs/',
},
sidebar: 'docs',
source: path.posix.join(
'@site',
posixPath(path.relative(siteDir, currentVersion.contentPath)),
'foo',
'baz.md',
),
title: 'baz',
description: 'Images',
frontMatter: {
id: 'baz',
title: 'baz',
slug: 'bazSlug.html',
},
});
expect(findDocById(currentVersion, 'hello')).toEqual({
...defaultDocMetadata,
version: 'current',
@ -352,6 +385,7 @@ describe('simple website', () => {
frontMatter: {
id: 'hello',
title: 'Hello, World !',
sidebar_label: 'Hello sidebar_label',
},
});