Skip to content
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

Jump to bottom

fix(v2): fix docs homepage permalink issues #2905

Merged
merged 18 commits into from
Jun 17, 2020
Merged

fix(v2): fix docs homepage permalink issues #2905

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
6734005
better fixes for docs homepage
slorber Jun 8, 2020
bfe01e2
fix tests
slorber Jun 8, 2020
32790d8
create special route for docs homepage + cleanup existing code
slorber Jun 8, 2020
edd5a1d
no need to create multiple docs parent paths
slorber Jun 8, 2020
280f08f
useful comment
slorber Jun 8, 2020
8e91f2b
add test for slug + doc home usage at the same time error
slorber Jun 8, 2020
3537cb8
remove confusing variable name
slorber Jun 8, 2020
ba27841
fix tests by using same suffix as before for docs base metadata path
slorber Jun 8, 2020
179f27f
Merge branch 'master' into refactor/docs-home-url
slorber Jun 9, 2020
5e7ee40
metadata: use homePageId correctly for nested docs: the full docId (i…
slorber Jun 9, 2020
e996ad2
add folder/testNested test doc
slorber Jun 9, 2020
66cd083
refactor a bit processMetadata, the home should be handled correctly …
slorber Jun 9, 2020
fd94d28
Workaround to fix issue when parent layout route (DocPage) has same p…
slorber Jun 10, 2020
268f964
revert homePageId
slorber Jun 10, 2020
0c0b6d1
remove test doc
slorber Jun 10, 2020
74d84d9
remove test doc
slorber Jun 10, 2020
829186c
add useful comment
slorber Jun 10, 2020
258c6ac
Merge branch 'master' into refactor/docs-home-url
slorber Jun 15, 2020
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
5 changes: 5 additions & 0 deletions ...t-docs/src/__tests__/__fixtures__/bad-slug-on-doc-home-site/docs/docWithSlug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
slug: docWithSlug.html
---

Lorem
102 changes: 51 additions & 51 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 @@ -29,7 +29,7 @@ Object {
"type": "link",
},
Object {
"href": "/docs",
"href": "/docs/",
"label": "Hello, World !",
"type": "link",
},
Expand All @@ -41,7 +41,7 @@ Object {
"collapsed": true,
"items": Array [
Object {
"href": "/docs",
"href": "/docs/",
"label": "Hello, World !",
"type": "link",
},
Expand All @@ -57,21 +57,21 @@ exports[`simple website content 2`] = `
Array [
Object {
"component": "@theme/DocPage",
"exact": true,
"modules": Object {
"content": "@site/docs/hello.md",
"docsMetadata": "~docs/site-docs-hello-md-9df-base.json",
},
"path": "/docs",
},
Object {
"component": "@theme/DocPage",
"exact": false,
"modules": Object {
"docsMetadata": "~docs/docs-route-ff2.json",
},
"path": "/docs/:route",
"path": "/docs",
"priority": undefined,
"routes": Array [
Object {
"component": "@theme/DocItem",
"exact": true,
"modules": Object {
"content": "@site/docs/hello.md",
},
"path": "/docs/",
},
Object {
"component": "@theme/DocItem",
"exact": true,
Expand Down Expand Up @@ -123,39 +123,21 @@ exports[`versioned website content 1`] = `
Array [
Object {
"component": "@theme/DocPage",
"exact": true,
"modules": Object {
"content": "@site/versioned_docs/version-1.0.1/hello.md",
"docsMetadata": "~docs/site-versioned-docs-version-1-0-1-hello-md-0c7-base.json",
},
"path": "/docs",
},
Object {
"component": "@theme/DocPage",
"exact": true,
"modules": Object {
"content": "@site/versioned_docs/version-1.0.0/hello.md",
"docsMetadata": "~docs/site-versioned-docs-version-1-0-0-hello-md-3ef-base.json",
},
"path": "/docs/1.0.0",
},
Object {
"component": "@theme/DocPage",
"exact": true,
"modules": Object {
"content": "@site/docs/hello.md",
"docsMetadata": "~docs/site-docs-hello-md-9df-base.json",
},
"path": "/docs/next",
},
Object {
"component": "@theme/DocPage",
"exact": false,
"modules": Object {
"docsMetadata": "~docs/docs-1-0-0-route-660.json",
},
"path": "/docs/1.0.0/:route",
"path": "/docs/1.0.0",
"priority": undefined,
"routes": Array [
Object {
"component": "@theme/DocItem",
"exact": true,
"modules": Object {
"content": "@site/versioned_docs/version-1.0.0/hello.md",
},
"path": "/docs/1.0.0/",
},
Object {
"component": "@theme/DocItem",
"exact": true,
Expand All @@ -176,12 +158,21 @@ Array [
},
Object {
"component": "@theme/DocPage",
"exact": false,
"modules": Object {
"docsMetadata": "~docs/docs-next-route-1c8.json",
},
"path": "/docs/next/:route",
"path": "/docs/next",
"priority": undefined,
"routes": Array [
Object {
"component": "@theme/DocItem",
"exact": true,
"modules": Object {
"content": "@site/docs/hello.md",
},
"path": "/docs/next/",
},
Object {
"component": "@theme/DocItem",
"exact": true,
Expand All @@ -194,12 +185,21 @@ Array [
},
Object {
"component": "@theme/DocPage",
"exact": false,
"modules": Object {
"docsMetadata": "~docs/docs-route-ff2.json",
},
"path": "/docs/:route",
"path": "/docs",
"priority": -1,
"routes": Array [
Object {
"component": "@theme/DocItem",
"exact": true,
"modules": Object {
"content": "@site/versioned_docs/version-1.0.1/hello.md",
},
"path": "/docs/",
},
Object {
"component": "@theme/DocItem",
"exact": true,
Expand Down Expand Up @@ -232,7 +232,7 @@ Object {
"collapsed": true,
"items": Array [
Object {
"href": "/docs/next",
"href": "/docs/next/",
"label": "hello",
"type": "link",
},
Expand Down Expand Up @@ -263,7 +263,7 @@ Object {
"collapsed": true,
"items": Array [
Object {
"href": "/docs/1.0.0",
"href": "/docs/1.0.0/",
"label": "hello",
"type": "link",
},
Expand All @@ -289,7 +289,7 @@ Object {
"collapsed": true,
"items": Array [
Object {
"href": "/docs",
"href": "/docs/",
"label": "hello",
"type": "link",
},
Expand Down Expand Up @@ -326,7 +326,7 @@ Object {
"collapsed": true,
"items": Array [
Object {
"href": "/docs/1.0.0",
"href": "/docs/1.0.0/",
"label": "hello",
"type": "link",
},
Expand All @@ -337,9 +337,9 @@ Object {
],
},
"permalinkToSidebar": Object {
"/docs/1.0.0/": "version-1.0.0/docs",
"/docs/1.0.0/foo/barSlug": "version-1.0.0/docs",
"/docs/1.0.0/foo/baz": "version-1.0.0/docs",
"/docs/1.0.0/hello": "version-1.0.0/docs",
},
"version": "1.0.0",
}
Expand All @@ -365,7 +365,7 @@ Object {
"collapsed": true,
"items": Array [
Object {
"href": "/docs",
"href": "/docs/",
"label": "hello",
"type": "link",
},
Expand All @@ -376,8 +376,8 @@ Object {
],
},
"permalinkToSidebar": Object {
"/docs/": "version-1.0.1/docs",
"/docs/foo/bar": "version-1.0.1/docs",
"/docs/hello": "version-1.0.1/docs",
},
"version": "1.0.1",
}
Expand All @@ -403,7 +403,7 @@ Object {
"collapsed": true,
"items": Array [
Object {
"href": "/docs/next",
"href": "/docs/next/",
"label": "hello",
"type": "link",
},
Expand All @@ -414,8 +414,8 @@ Object {
],
},
"permalinkToSidebar": Object {
"/docs/next/": "docs",
"/docs/next/foo/barSlug": "docs",
"/docs/next/hello": "docs",
},
"version": "next",
}
Expand Down
16 changes: 11 additions & 5 deletions packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,8 @@ describe('simple website', () => {
expect(versionToSidebars).toEqual({});
expect(docsMetadata.hello).toEqual({
id: 'hello',
permalink: '/docs/hello',
isDocsHomePage: true,
permalink: '/docs/',
previous: {
title: 'baz',
permalink: '/docs/foo/bazSlug.html',
Expand All @@ -167,6 +168,7 @@ describe('simple website', () => {

expect(docsMetadata['foo/bar']).toEqual({
id: 'foo/bar',
isDocsHomePage: false,
next: {
title: 'baz',
permalink: '/docs/foo/bazSlug.html',
Expand Down Expand Up @@ -294,6 +296,7 @@ describe('versioned website', () => {
expect(docsMetadata['version-1.0.1/foo/baz']).toBeUndefined();
expect(docsMetadata['foo/bar']).toEqual({
id: 'foo/bar',
isDocsHomePage: false,
permalink: '/docs/next/foo/barSlug',
source: path.join('@site', routeBasePath, 'foo', 'bar.md'),
title: 'bar',
Expand All @@ -302,12 +305,13 @@ describe('versioned website', () => {
sidebar: 'docs',
next: {
title: 'hello',
permalink: '/docs/next/hello',
permalink: '/docs/next/',
},
});
expect(docsMetadata['hello']).toEqual({
id: 'hello',
permalink: '/docs/next/hello',
isDocsHomePage: true,
permalink: '/docs/next/',
source: path.join('@site', routeBasePath, 'hello.md'),
title: 'hello',
description: 'Hello next !',
Expand All @@ -320,7 +324,8 @@ describe('versioned website', () => {
});
expect(docsMetadata['version-1.0.1/hello']).toEqual({
id: 'version-1.0.1/hello',
permalink: '/docs/hello',
isDocsHomePage: true,
permalink: '/docs/',
source: path.join(
'@site',
path.relative(siteDir, versionedDir),
Expand All @@ -338,6 +343,7 @@ describe('versioned website', () => {
});
expect(docsMetadata['version-1.0.0/foo/baz']).toEqual({
id: 'version-1.0.0/foo/baz',
isDocsHomePage: false,
permalink: '/docs/1.0.0/foo/baz',
source: path.join(
'@site',
Expand All @@ -353,7 +359,7 @@ describe('versioned website', () => {
sidebar: 'version-1.0.0/docs',
next: {
title: 'hello',
permalink: '/docs/1.0.0/hello',
permalink: '/docs/1.0.0/',
},
previous: {
title: 'bar',
Expand Down
Loading