Skip to content

fix(content-docs): restore behavior when pagination front matter is null #6124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Josh-Cena merged 2 commits into from
Dec 18, 2021
Merged

fix(content-docs): restore behavior when pagination front matter is null #6124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5081e5
fix(content-docs): restore behavior when pagination front matter is null
Josh-Cena Dec 18, 2021
165ac7f
update snaps
Josh-Cena Dec 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...urus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/bar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
id: bar
title: Bar
description: This is custom description
pagination_next: null
pagination_prev: null
---

# Remarkable
Expand Down
10 changes: 2 additions & 8 deletions packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,8 @@
exports[`simple site custom pagination 1`] = `
Array [
Array [
Object {
"permalink": "/docs/rootTryToEscapeSlug",
"title": "rootTryToEscapeSlug",
},
Object {
"permalink": "/docs/foo/bazSlug.html",
"title": "baz pagination_label",
},
undefined,
undefined,
],
Array [
Object {
Expand Down
17 changes: 7 additions & 10 deletions packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,15 +127,14 @@ Object {
"frontMatter": Object {
"description": "This is custom description",
"id": "bar",
"pagination_next": null,
"pagination_prev": null,
"title": "Bar",
},
"id": "foo/bar",
"lastUpdatedAt": undefined,
"lastUpdatedBy": undefined,
"next": Object {
"permalink": "/docs/foo/bazSlug.html",
"title": "baz pagination_label",
},
"next": undefined,
"permalink": "/docs/foo/bar",
"previous": undefined,
"sidebar": "docs",
Expand Down Expand Up @@ -341,13 +340,11 @@ Object {
\\"frontMatter\\": {
\\"id\\": \\"bar\\",
\\"title\\": \\"Bar\\",
\\"description\\": \\"This is custom description\\"
\\"description\\": \\"This is custom description\\",
\\"pagination_next\\": null,
\\"pagination_prev\\": null
},
\\"sidebar\\": \\"docs\\",
\\"next\\": {
\\"title\\": \\"baz pagination_label\\",
\\"permalink\\": \\"/docs/foo/bazSlug.html\\"
}
\\"sidebar\\": \\"docs\\"
}",
"site-docs-foo-baz-md-a69.json": "{
\\"unversionedId\\": \\"foo/baz\\",
Expand Down
2 changes: 2 additions & 0 deletions packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,8 @@ describe('simple site', () => {
description: 'This is custom description',
id: 'bar',
title: 'Bar',
pagination_next: null,
pagination_prev: null,
},
tags: [],
});
Expand Down
14 changes: 8 additions & 6 deletions packages/docusaurus-plugin-content-docs/src/docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,12 +319,14 @@ export function addDocNavigation(
return toDocNavigationLink(navDoc);
};

const previous: DocNavLink | undefined = doc.frontMatter.pagination_prev
? toNavigationLinkByDocId(doc.frontMatter.pagination_prev, 'prev')
: toNavigationLink(navigation.previous, docsById);
const next: DocNavLink | undefined = doc.frontMatter.pagination_next
? toNavigationLinkByDocId(doc.frontMatter.pagination_next, 'next')
: toNavigationLink(navigation.next, docsById);
const previous =
doc.frontMatter.pagination_prev !== undefined
? toNavigationLinkByDocId(doc.frontMatter.pagination_prev, 'prev')
: toNavigationLink(navigation.previous, docsById);
const next =
doc.frontMatter.pagination_next !== undefined
? toNavigationLinkByDocId(doc.frontMatter.pagination_next, 'next')
: toNavigationLink(navigation.next, docsById);

return {...doc, sidebar: navigation.sidebarName, previous, next};
}
Expand Down