@docusaurus/plugin-content-docs 2.0.0-beta.138b4c997 → 2.0.0-beta.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. package/lib/categoryGeneratedIndex.d.ts +12 -0
  2. package/lib/categoryGeneratedIndex.js +37 -0
  3. package/lib/cli.d.ts +2 -2
  4. package/lib/cli.js +14 -35
  5. package/lib/client/docsClientUtils.d.ts +0 -3
  6. package/lib/client/docsClientUtils.js +19 -22
  7. package/lib/docFrontMatter.d.ts +1 -1
  8. package/lib/docFrontMatter.js +8 -4
  9. package/lib/docs.d.ts +25 -3
  10. package/lib/docs.js +126 -41
  11. package/lib/globalData.d.ts +1 -1
  12. package/lib/index.d.ts +1 -1
  13. package/lib/index.js +101 -133
  14. package/lib/lastUpdate.js +12 -12
  15. package/lib/markdown/index.d.ts +3 -6
  16. package/lib/markdown/index.js +3 -3
  17. package/lib/markdown/linkify.js +2 -2
  18. package/lib/numberPrefix.d.ts +1 -1
  19. package/lib/options.d.ts +3 -3
  20. package/lib/options.js +48 -11
  21. package/lib/props.d.ts +7 -2
  22. package/lib/props.js +60 -9
  23. package/lib/routes.d.ts +27 -0
  24. package/lib/routes.js +105 -0
  25. package/lib/{sidebarItemsGenerator.d.ts → sidebars/generator.d.ts} +5 -2
  26. package/lib/sidebars/generator.js +216 -0
  27. package/lib/sidebars/index.d.ts +15 -0
  28. package/lib/sidebars/index.js +73 -0
  29. package/lib/sidebars/normalization.d.ts +14 -0
  30. package/lib/sidebars/normalization.js +77 -0
  31. package/lib/sidebars/processor.d.ts +18 -0
  32. package/lib/sidebars/processor.js +85 -0
  33. package/lib/sidebars/types.d.ts +127 -0
  34. package/{src/__tests__/__fixtures__/site-with-autogenerated-sidebar/partialAutogeneratedSidebars2.js → lib/sidebars/types.js} +2 -10
  35. package/lib/sidebars/utils.d.ts +35 -0
  36. package/lib/sidebars/utils.js +228 -0
  37. package/lib/sidebars/validation.d.ts +10 -0
  38. package/lib/sidebars/validation.js +138 -0
  39. package/lib/slug.d.ts +4 -3
  40. package/lib/slug.js +27 -15
  41. package/{src/__tests__/__fixtures__/site-with-doc-label/docusaurus.config.js → lib/tags.d.ts} +2 -8
  42. package/lib/tags.js +20 -0
  43. package/lib/theme/hooks/useDocs.js +24 -21
  44. package/lib/translations.d.ts +2 -2
  45. package/lib/translations.js +71 -29
  46. package/lib/types.d.ts +52 -64
  47. package/lib/versions.d.ts +3 -3
  48. package/lib/versions.js +41 -22
  49. package/package.json +20 -20
  50. package/src/categoryGeneratedIndex.ts +57 -0
  51. package/src/cli.ts +10 -42
  52. package/src/client/docsClientUtils.ts +14 -26
  53. package/{types.d.ts → src/deps.d.ts} +0 -0
  54. package/src/docFrontMatter.ts +10 -5
  55. package/src/docs.ts +164 -36
  56. package/src/globalData.ts +6 -1
  57. package/src/index.ts +127 -177
  58. package/src/lastUpdate.ts +14 -16
  59. package/src/markdown/index.ts +8 -12
  60. package/src/numberPrefix.ts +5 -3
  61. package/src/options.ts +56 -15
  62. package/src/plugin-content-docs.d.ts +172 -43
  63. package/src/props.ts +90 -16
  64. package/src/routes.ts +169 -0
  65. package/src/sidebars/generator.ts +302 -0
  66. package/src/sidebars/index.ts +94 -0
  67. package/src/sidebars/normalization.ts +112 -0
  68. package/src/sidebars/processor.ts +154 -0
  69. package/src/sidebars/types.ts +211 -0
  70. package/src/sidebars/utils.ts +329 -0
  71. package/src/sidebars/validation.ts +168 -0
  72. package/src/slug.ts +32 -17
  73. package/src/tags.ts +19 -0
  74. package/src/theme/hooks/useDocs.ts +5 -1
  75. package/src/translations.ts +103 -47
  76. package/src/types.ts +64 -108
  77. package/src/versions.ts +59 -25
  78. package/lib/.tsbuildinfo +0 -1
  79. package/lib/sidebarItemsGenerator.js +0 -211
  80. package/lib/sidebars.d.ts +0 -43
  81. package/lib/sidebars.js +0 -320
  82. package/src/__tests__/__fixtures__/bad-id-site/docs/invalid-id.md +0 -5
  83. package/src/__tests__/__fixtures__/bad-slug-on-doc-home-site/docs/docWithSlug.md +0 -5
  84. package/src/__tests__/__fixtures__/empty-site/docusaurus.config.js +0 -16
  85. package/src/__tests__/__fixtures__/empty-site/sidebars.json +0 -1
  86. package/src/__tests__/__fixtures__/sidebars/sidebars-category-shorthand.js +0 -34
  87. package/src/__tests__/__fixtures__/sidebars/sidebars-category-wrong-items.json +0 -11
  88. package/src/__tests__/__fixtures__/sidebars/sidebars-category-wrong-label.json +0 -11
  89. package/src/__tests__/__fixtures__/sidebars/sidebars-category.js +0 -44
  90. package/src/__tests__/__fixtures__/sidebars/sidebars-collapsed-first-level.json +0 -20
  91. package/src/__tests__/__fixtures__/sidebars/sidebars-collapsed.json +0 -21
  92. package/src/__tests__/__fixtures__/sidebars/sidebars-doc-id-not-string.json +0 -10
  93. package/src/__tests__/__fixtures__/sidebars/sidebars-first-level-not-category.js +0 -20
  94. package/src/__tests__/__fixtures__/sidebars/sidebars-link-wrong-href.json +0 -11
  95. package/src/__tests__/__fixtures__/sidebars/sidebars-link-wrong-label.json +0 -11
  96. package/src/__tests__/__fixtures__/sidebars/sidebars-link.json +0 -11
  97. package/src/__tests__/__fixtures__/sidebars/sidebars-unknown-type.json +0 -14
  98. package/src/__tests__/__fixtures__/sidebars/sidebars-wrong-field.json +0 -20
  99. package/src/__tests__/__fixtures__/sidebars/sidebars.json +0 -20
  100. package/src/__tests__/__fixtures__/simple-site/docs/foo/bar.md +0 -69
  101. package/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md +0 -70
  102. package/src/__tests__/__fixtures__/simple-site/docs/headingAsTitle.md +0 -1
  103. package/src/__tests__/__fixtures__/simple-site/docs/hello.md +0 -53
  104. package/src/__tests__/__fixtures__/simple-site/docs/ipsum.md +0 -5
  105. package/src/__tests__/__fixtures__/simple-site/docs/lorem.md +0 -6
  106. package/src/__tests__/__fixtures__/simple-site/docs/rootAbsoluteSlug.md +0 -5
  107. package/src/__tests__/__fixtures__/simple-site/docs/rootRelativeSlug.md +0 -5
  108. package/src/__tests__/__fixtures__/simple-site/docs/rootResolvedSlug.md +0 -5
  109. package/src/__tests__/__fixtures__/simple-site/docs/rootTryToEscapeSlug.md +0 -5
  110. package/src/__tests__/__fixtures__/simple-site/docs/slugs/absoluteSlug.md +0 -5
  111. package/src/__tests__/__fixtures__/simple-site/docs/slugs/relativeSlug.md +0 -5
  112. package/src/__tests__/__fixtures__/simple-site/docs/slugs/resolvedSlug.md +0 -5
  113. package/src/__tests__/__fixtures__/simple-site/docs/slugs/tryToEscapeSlug.md +0 -5
  114. package/src/__tests__/__fixtures__/simple-site/docusaurus.config.js +0 -14
  115. package/src/__tests__/__fixtures__/simple-site/sidebars.json +0 -23
  116. package/src/__tests__/__fixtures__/simple-site/wrong-sidebars.json +0 -7
  117. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/0-getting-started.md +0 -3
  118. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/1-installation.md +0 -3
  119. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/00_api-overview.md +0 -3
  120. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/01_Core APIs/0 --- Client API.md +0 -1
  121. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/01_Core APIs/1 --- Server API.md +0 -1
  122. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/0. Plugin API.md +0 -1
  123. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/1. Theme API.md +0 -1
  124. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/_category_.yml +0 -1
  125. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/03_api-end.md +0 -3
  126. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/_category_.json +0 -3
  127. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/0-guide2.5.md +0 -8
  128. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/02-guide2.md +0 -7
  129. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/_category_.json +0 -3
  130. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/a-guide4.md +0 -7
  131. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/b-guide5.md +0 -7
  132. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/guide3.md +0 -8
  133. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/z-guide1.md +0 -8
  134. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docusaurus.config.js +0 -14
  135. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/partialAutogeneratedSidebars.js +0 -23
  136. package/src/__tests__/__fixtures__/site-with-doc-label/docs/hello-1.md +0 -7
  137. package/src/__tests__/__fixtures__/site-with-doc-label/docs/hello-2.md +0 -8
  138. package/src/__tests__/__fixtures__/site-with-doc-label/sidebars.json +0 -14
  139. package/src/__tests__/__fixtures__/versioned-site/community/team.md +0 -1
  140. package/src/__tests__/__fixtures__/versioned-site/community_sidebars.json +0 -3
  141. package/src/__tests__/__fixtures__/versioned-site/community_versioned_docs/version-1.0.0/team.md +0 -1
  142. package/src/__tests__/__fixtures__/versioned-site/community_versioned_sidebars/version-1.0.0-sidebars.json +0 -3
  143. package/src/__tests__/__fixtures__/versioned-site/community_versions.json +0 -1
  144. package/src/__tests__/__fixtures__/versioned-site/docs/foo/bar.md +0 -4
  145. package/src/__tests__/__fixtures__/versioned-site/docs/hello.md +0 -1
  146. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/absoluteSlug.md +0 -5
  147. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/relativeSlug.md +0 -5
  148. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/resolvedSlug.md +0 -5
  149. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/tryToEscapeSlug.md +0 -5
  150. package/src/__tests__/__fixtures__/versioned-site/docusaurus.config.js +0 -18
  151. package/src/__tests__/__fixtures__/versioned-site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md +0 -1
  152. package/src/__tests__/__fixtures__/versioned-site/i18n/en/docusaurus-plugin-content-docs-community/current/team.md +0 -5
  153. package/src/__tests__/__fixtures__/versioned-site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md +0 -1
  154. package/src/__tests__/__fixtures__/versioned-site/sidebars.json +0 -10
  155. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/foo/bar.md +0 -4
  156. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/foo/baz.md +0 -1
  157. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/hello.md +0 -1
  158. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/foo/bar.md +0 -1
  159. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/hello.md +0 -1
  160. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootAbsoluteSlug.md +0 -5
  161. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootRelativeSlug.md +0 -5
  162. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootResolvedSlug.md +0 -5
  163. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootTryToEscapeSlug.md +0 -5
  164. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/absoluteSlug.md +0 -5
  165. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/relativeSlug.md +0 -5
  166. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/resolvedSlug.md +0 -5
  167. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/tryToEscapeSlug.md +0 -5
  168. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.0-sidebars.json +0 -11
  169. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.1-sidebars.json +0 -10
  170. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-withSlugs-sidebars.json +0 -5
  171. package/src/__tests__/__fixtures__/versioned-site/versions.json +0 -5
  172. package/src/__tests__/__snapshots__/cli.test.ts.snap +0 -90
  173. package/src/__tests__/__snapshots__/index.test.ts.snap +0 -1916
  174. package/src/__tests__/__snapshots__/sidebars.test.ts.snap +0 -218
  175. package/src/__tests__/__snapshots__/translations.test.ts.snap +0 -487
  176. package/src/__tests__/cli.test.ts +0 -333
  177. package/src/__tests__/docFrontMatter.test.ts +0 -244
  178. package/src/__tests__/docs.test.ts +0 -878
  179. package/src/__tests__/index.test.ts +0 -1871
  180. package/src/__tests__/lastUpdate.test.ts +0 -69
  181. package/src/__tests__/numberPrefix.test.ts +0 -199
  182. package/src/__tests__/options.test.ts +0 -231
  183. package/src/__tests__/sidebarItemsGenerator.test.ts +0 -336
  184. package/src/__tests__/sidebars.test.ts +0 -639
  185. package/src/__tests__/slug.test.ts +0 -109
  186. package/src/__tests__/translations.test.ts +0 -159
  187. package/src/__tests__/versions.test.ts +0 -741
  188. package/src/client/__tests__/docsClientUtils.test.ts +0 -371
  189. package/src/markdown/__tests__/__fixtures__/docs/doc-localized.md +0 -1
  190. package/src/markdown/__tests__/__fixtures__/docs/doc1.md +0 -13
  191. package/src/markdown/__tests__/__fixtures__/docs/doc2.md +0 -12
  192. package/src/markdown/__tests__/__fixtures__/docs/doc4.md +0 -19
  193. package/src/markdown/__tests__/__fixtures__/docs/doc5.md +0 -6
  194. package/src/markdown/__tests__/__fixtures__/docs/subdir/doc3.md +0 -3
  195. package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/doc2.md +0 -7
  196. package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/subdir/doc1.md +0 -3
  197. package/src/markdown/__tests__/__snapshots__/linkify.test.ts.snap +0 -82
  198. package/src/markdown/__tests__/linkify.test.ts +0 -190
  199. package/src/sidebarItemsGenerator.ts +0 -307
  200. package/src/sidebars.ts +0 -522
  201. package/tsconfig.json +0 -9
@@ -1,878 +0,0 @@
1
- /**
2
- * Copyright (c) Facebook, Inc. and its affiliates.
3
- *
4
- * This source code is licensed under the MIT license found in the
5
- * LICENSE file in the root directory of this source tree.
6
- */
7
-
8
- import path from 'path';
9
- import {loadContext} from '@docusaurus/core/src/server/index';
10
- import {processDocMetadata, readVersionDocs, readDocFile} from '../docs';
11
- import {readVersionsMetadata} from '../versions';
12
- import {
13
- DocFile,
14
- DocMetadataBase,
15
- MetadataOptions,
16
- VersionMetadata,
17
- PluginOptions,
18
- EditUrlFunction,
19
- } from '../types';
20
- import {LoadContext} from '@docusaurus/types';
21
- import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
22
- import {DEFAULT_OPTIONS} from '../options';
23
- import {Optional} from 'utility-types';
24
- import {posixPath} from '@docusaurus/utils';
25
-
26
- const fixtureDir = path.join(__dirname, '__fixtures__');
27
-
28
- const createFakeDocFile = ({
29
- source,
30
- frontmatter = {},
31
- markdown = 'some markdown content',
32
- }: {
33
- source: string;
34
- frontmatter?: Record<string, string>;
35
- markdown?: string;
36
- }): DocFile => {
37
- const content = `---
38
- ${Object.entries(frontmatter)
39
- .map(([key, value]) => `${key}: ${value}`)
40
- .join('\n')}
41
- ---
42
- ${markdown}
43
- `;
44
- return {
45
- source,
46
- content,
47
- lastUpdate: {},
48
- contentPath: 'docs',
49
- filePath: source,
50
- };
51
- };
52
-
53
- function createTestUtils({
54
- siteDir,
55
- context,
56
- versionMetadata,
57
- options,
58
- }: {
59
- siteDir: string;
60
- context: LoadContext;
61
- versionMetadata: VersionMetadata;
62
- options: MetadataOptions;
63
- }) {
64
- async function readDoc(docFileSource: string) {
65
- return readDocFile(versionMetadata, docFileSource, options);
66
- }
67
- function processDocFile(docFile: DocFile) {
68
- return processDocMetadata({
69
- docFile,
70
- versionMetadata,
71
- options,
72
- context,
73
- });
74
- }
75
- async function testMeta(
76
- docFileSource: string,
77
- expectedMetadata: Optional<
78
- DocMetadataBase,
79
- 'source' | 'lastUpdatedBy' | 'lastUpdatedAt' | 'editUrl'
80
- >,
81
- ) {
82
- const docFile = await readDoc(docFileSource);
83
- const metadata = await processDocMetadata({
84
- docFile,
85
- versionMetadata,
86
- context,
87
- options,
88
- });
89
- expect(metadata).toEqual({
90
- lastUpdatedBy: undefined,
91
- lastUpdatedAt: undefined,
92
- editUrl: undefined,
93
- source: path.posix.join(
94
- '@site',
95
- posixPath(path.relative(siteDir, versionMetadata.contentPath)),
96
- posixPath(docFileSource),
97
- ),
98
- ...expectedMetadata,
99
- });
100
- }
101
-
102
- async function testSlug(docFileSource: string, expectedPermalink: string) {
103
- const docFile = await readDoc(docFileSource);
104
- const metadata = await processDocMetadata({
105
- docFile,
106
- versionMetadata,
107
- context,
108
- options,
109
- });
110
- expect(metadata.permalink).toEqual(expectedPermalink);
111
- }
112
-
113
- return {processDocFile, testMeta, testSlug};
114
- }
115
-
116
- describe('simple site', () => {
117
- async function loadSite(
118
- loadSiteOptions: {options: Partial<PluginOptions>} = {options: {}},
119
- ) {
120
- const siteDir = path.join(fixtureDir, 'simple-site');
121
- const context = await loadContext(siteDir);
122
- const options = {
123
- id: DEFAULT_PLUGIN_ID,
124
- ...DEFAULT_OPTIONS,
125
- ...loadSiteOptions.options,
126
- };
127
- const versionsMetadata = readVersionsMetadata({
128
- context,
129
- options,
130
- });
131
- expect(versionsMetadata.length).toEqual(1);
132
- const [currentVersion] = versionsMetadata;
133
-
134
- const defaultTestUtils = createTestUtils({
135
- siteDir,
136
- context,
137
- options,
138
- versionMetadata: currentVersion,
139
- });
140
- return {
141
- siteDir,
142
- context,
143
- options,
144
- versionsMetadata,
145
- defaultTestUtils,
146
- currentVersion,
147
- };
148
- }
149
-
150
- test('readVersionDocs', async () => {
151
- const {options, currentVersion} = await loadSite();
152
- const docs = await readVersionDocs(currentVersion, options);
153
- expect(docs.map((doc) => doc.source).sort()).toEqual(
154
- [
155
- 'hello.md',
156
- 'ipsum.md',
157
- 'lorem.md',
158
- 'rootAbsoluteSlug.md',
159
- 'rootRelativeSlug.md',
160
- 'rootResolvedSlug.md',
161
- 'rootTryToEscapeSlug.md',
162
- 'headingAsTitle.md',
163
- 'foo/bar.md',
164
- 'foo/baz.md',
165
- 'slugs/absoluteSlug.md',
166
- 'slugs/relativeSlug.md',
167
- 'slugs/resolvedSlug.md',
168
- 'slugs/tryToEscapeSlug.md',
169
- ].sort(),
170
- );
171
- });
172
-
173
- test('normal docs', async () => {
174
- const {defaultTestUtils} = await loadSite();
175
- await defaultTestUtils.testMeta(path.join('foo', 'bar.md'), {
176
- version: 'current',
177
- id: 'foo/bar',
178
- unversionedId: 'foo/bar',
179
- sourceDirName: 'foo',
180
- isDocsHomePage: false,
181
- permalink: '/docs/foo/bar',
182
- slug: '/foo/bar',
183
- title: 'Bar',
184
- description: 'This is custom description',
185
- frontMatter: {
186
- description: 'This is custom description',
187
- id: 'bar',
188
- title: 'Bar',
189
- },
190
- });
191
- await defaultTestUtils.testMeta(path.join('hello.md'), {
192
- version: 'current',
193
- id: 'hello',
194
- unversionedId: 'hello',
195
- sourceDirName: '.',
196
- isDocsHomePage: false,
197
- permalink: '/docs/hello',
198
- slug: '/hello',
199
- title: 'Hello, World !',
200
- description: `Hi, Endilie here :)`,
201
- frontMatter: {
202
- id: 'hello',
203
- title: 'Hello, World !',
204
- sidebar_label: 'Hello sidebar_label',
205
- },
206
- });
207
- });
208
-
209
- test('homePageId doc', async () => {
210
- const {siteDir, context, options, currentVersion} = await loadSite({
211
- options: {homePageId: 'hello'},
212
- });
213
-
214
- const testUtilsLocal = createTestUtils({
215
- siteDir,
216
- context,
217
- options,
218
- versionMetadata: currentVersion,
219
- });
220
-
221
- await testUtilsLocal.testMeta(path.join('hello.md'), {
222
- version: 'current',
223
- id: 'hello',
224
- unversionedId: 'hello',
225
- sourceDirName: '.',
226
- isDocsHomePage: true,
227
- permalink: '/docs/',
228
- slug: '/',
229
- title: 'Hello, World !',
230
- description: `Hi, Endilie here :)`,
231
- frontMatter: {
232
- id: 'hello',
233
- title: 'Hello, World !',
234
- sidebar_label: 'Hello sidebar_label',
235
- },
236
- });
237
- });
238
-
239
- test('homePageId doc nested', async () => {
240
- const {siteDir, context, options, currentVersion} = await loadSite({
241
- options: {homePageId: 'foo/bar'},
242
- });
243
-
244
- const testUtilsLocal = createTestUtils({
245
- siteDir,
246
- context,
247
- options,
248
- versionMetadata: currentVersion,
249
- });
250
-
251
- await testUtilsLocal.testMeta(path.join('foo', 'bar.md'), {
252
- version: 'current',
253
- id: 'foo/bar',
254
- unversionedId: 'foo/bar',
255
- sourceDirName: 'foo',
256
- isDocsHomePage: true,
257
- permalink: '/docs/',
258
- slug: '/',
259
- title: 'Bar',
260
- description: 'This is custom description',
261
- frontMatter: {
262
- description: 'This is custom description',
263
- id: 'bar',
264
- title: 'Bar',
265
- },
266
- });
267
- });
268
-
269
- test('docs with editUrl', async () => {
270
- const {siteDir, context, options, currentVersion} = await loadSite({
271
- options: {
272
- editUrl: 'https://github.com/facebook/docusaurus/edit/master/website',
273
- },
274
- });
275
-
276
- const testUtilsLocal = createTestUtils({
277
- siteDir,
278
- context,
279
- options,
280
- versionMetadata: currentVersion,
281
- });
282
-
283
- await testUtilsLocal.testMeta(path.join('foo', 'baz.md'), {
284
- version: 'current',
285
- id: 'foo/baz',
286
- unversionedId: 'foo/baz',
287
- sourceDirName: 'foo',
288
- isDocsHomePage: false,
289
- permalink: '/docs/foo/bazSlug.html',
290
- slug: '/foo/bazSlug.html',
291
- title: 'baz',
292
- editUrl:
293
- 'https://github.com/facebook/docusaurus/edit/master/website/docs/foo/baz.md',
294
- description: 'Images',
295
- frontMatter: {
296
- id: 'baz',
297
- slug: 'bazSlug.html',
298
- title: 'baz',
299
- pagination_label: 'baz pagination_label',
300
- },
301
- });
302
- });
303
-
304
- test('docs with custom editUrl & unrelated frontmatter', async () => {
305
- const {defaultTestUtils} = await loadSite();
306
-
307
- await defaultTestUtils.testMeta('lorem.md', {
308
- version: 'current',
309
- id: 'lorem',
310
- unversionedId: 'lorem',
311
- sourceDirName: '.',
312
- isDocsHomePage: false,
313
- permalink: '/docs/lorem',
314
- slug: '/lorem',
315
- title: 'lorem',
316
- editUrl: 'https://github.com/customUrl/docs/lorem.md',
317
- description: 'Lorem ipsum.',
318
- frontMatter: {
319
- custom_edit_url: 'https://github.com/customUrl/docs/lorem.md',
320
- unrelated_frontmatter: "won't be part of metadata",
321
- },
322
- });
323
- });
324
-
325
- test('docs with function editUrl', async () => {
326
- const hardcodedEditUrl = 'hardcoded-edit-url';
327
-
328
- const editUrlFunction: EditUrlFunction = jest.fn(() => hardcodedEditUrl);
329
-
330
- const {siteDir, context, options, currentVersion} = await loadSite({
331
- options: {
332
- editUrl: editUrlFunction,
333
- },
334
- });
335
-
336
- const testUtilsLocal = createTestUtils({
337
- siteDir,
338
- context,
339
- options,
340
- versionMetadata: currentVersion,
341
- });
342
-
343
- await testUtilsLocal.testMeta(path.join('foo', 'baz.md'), {
344
- version: 'current',
345
- id: 'foo/baz',
346
- unversionedId: 'foo/baz',
347
- sourceDirName: 'foo',
348
- isDocsHomePage: false,
349
- permalink: '/docs/foo/bazSlug.html',
350
- slug: '/foo/bazSlug.html',
351
- title: 'baz',
352
- editUrl: hardcodedEditUrl,
353
- description: 'Images',
354
- frontMatter: {
355
- id: 'baz',
356
- slug: 'bazSlug.html',
357
- title: 'baz',
358
- pagination_label: 'baz pagination_label',
359
- },
360
- });
361
-
362
- expect(editUrlFunction).toHaveBeenCalledTimes(1);
363
- expect(editUrlFunction).toHaveBeenCalledWith({
364
- version: 'current',
365
- versionDocsDirPath: 'docs',
366
- docPath: path.posix.join('foo', 'baz.md'),
367
- permalink: '/docs/foo/bazSlug.html',
368
- locale: 'en',
369
- });
370
- });
371
-
372
- test('docs with last update time and author', async () => {
373
- const {siteDir, context, options, currentVersion} = await loadSite({
374
- options: {
375
- showLastUpdateAuthor: true,
376
- showLastUpdateTime: true,
377
- },
378
- });
379
-
380
- const testUtilsLocal = createTestUtils({
381
- siteDir,
382
- context,
383
- options,
384
- versionMetadata: currentVersion,
385
- });
386
-
387
- await testUtilsLocal.testMeta('lorem.md', {
388
- version: 'current',
389
- id: 'lorem',
390
- unversionedId: 'lorem',
391
- sourceDirName: '.',
392
- isDocsHomePage: false,
393
- permalink: '/docs/lorem',
394
- slug: '/lorem',
395
- title: 'lorem',
396
- editUrl: 'https://github.com/customUrl/docs/lorem.md',
397
- description: 'Lorem ipsum.',
398
- frontMatter: {
399
- custom_edit_url: 'https://github.com/customUrl/docs/lorem.md',
400
- unrelated_frontmatter: "won't be part of metadata",
401
- },
402
- lastUpdatedAt: 1539502055,
403
- formattedLastUpdatedAt: '10/14/2018',
404
- lastUpdatedBy: 'Author',
405
- });
406
- });
407
-
408
- test('docs with slugs', async () => {
409
- const {defaultTestUtils} = await loadSite();
410
-
411
- await defaultTestUtils.testSlug(
412
- path.join('rootRelativeSlug.md'),
413
- '/docs/rootRelativeSlug',
414
- );
415
- await defaultTestUtils.testSlug(
416
- path.join('rootAbsoluteSlug.md'),
417
- '/docs/rootAbsoluteSlug',
418
- );
419
- await defaultTestUtils.testSlug(
420
- path.join('rootResolvedSlug.md'),
421
- '/docs/hey/rootResolvedSlug',
422
- );
423
- await defaultTestUtils.testSlug(
424
- path.join('rootTryToEscapeSlug.md'),
425
- '/docs/rootTryToEscapeSlug',
426
- );
427
-
428
- await defaultTestUtils.testSlug(
429
- path.join('slugs', 'absoluteSlug.md'),
430
- '/docs/absoluteSlug',
431
- );
432
- await defaultTestUtils.testSlug(
433
- path.join('slugs', 'relativeSlug.md'),
434
- '/docs/slugs/relativeSlug',
435
- );
436
- await defaultTestUtils.testSlug(
437
- path.join('slugs', 'resolvedSlug.md'),
438
- '/docs/slugs/hey/resolvedSlug',
439
- );
440
- await defaultTestUtils.testSlug(
441
- path.join('slugs', 'tryToEscapeSlug.md'),
442
- '/docs/tryToEscapeSlug',
443
- );
444
- });
445
-
446
- test('docs with invalid id', async () => {
447
- const {defaultTestUtils} = await loadSite();
448
- expect(() => {
449
- defaultTestUtils.processDocFile(
450
- createFakeDocFile({
451
- source: 'some/fake/path',
452
- frontmatter: {
453
- id: 'Hello/world',
454
- },
455
- }),
456
- );
457
- }).toThrowErrorMatchingInlineSnapshot(
458
- `"Document id \\"Hello/world\\" cannot include slash."`,
459
- );
460
- });
461
-
462
- test('docs with slug on doc home', async () => {
463
- const {siteDir, context, options, currentVersion} = await loadSite({
464
- options: {
465
- homePageId: 'homePageId',
466
- },
467
- });
468
-
469
- const testUtilsLocal = createTestUtils({
470
- siteDir,
471
- context,
472
- options,
473
- versionMetadata: currentVersion,
474
- });
475
- expect(() => {
476
- testUtilsLocal.processDocFile(
477
- createFakeDocFile({
478
- source: 'homePageId',
479
- frontmatter: {
480
- slug: '/x/y',
481
- },
482
- }),
483
- );
484
- }).toThrowErrorMatchingInlineSnapshot(
485
- `"The docs homepage (homePageId=homePageId) is not allowed to have a frontmatter slug=/x/y => you have to choose either homePageId or slug, not both"`,
486
- );
487
- });
488
- });
489
-
490
- describe('versioned site', () => {
491
- async function loadSite(
492
- loadSiteOptions: {options: Partial<PluginOptions>; locale?: string} = {
493
- options: {},
494
- },
495
- ) {
496
- const siteDir = path.join(fixtureDir, 'versioned-site');
497
- const context = await loadContext(siteDir, {
498
- locale: loadSiteOptions.locale,
499
- });
500
- const options = {
501
- id: DEFAULT_PLUGIN_ID,
502
- ...DEFAULT_OPTIONS,
503
- ...loadSiteOptions.options,
504
- };
505
- const versionsMetadata = readVersionsMetadata({
506
- context,
507
- options,
508
- });
509
- expect(versionsMetadata.length).toEqual(4);
510
- const [
511
- currentVersion,
512
- version101,
513
- version100,
514
- versionWithSlugs,
515
- ] = versionsMetadata;
516
-
517
- const currentVersionTestUtils = createTestUtils({
518
- siteDir,
519
- context,
520
- options,
521
- versionMetadata: currentVersion,
522
- });
523
- const version101TestUtils = createTestUtils({
524
- siteDir,
525
- context,
526
- options,
527
- versionMetadata: version101,
528
- });
529
-
530
- const version100TestUtils = createTestUtils({
531
- siteDir,
532
- context,
533
- options,
534
- versionMetadata: version100,
535
- });
536
-
537
- const versionWithSlugsTestUtils = createTestUtils({
538
- siteDir,
539
- context,
540
- options,
541
- versionMetadata: versionWithSlugs,
542
- });
543
-
544
- return {
545
- siteDir,
546
- context,
547
- options,
548
- versionsMetadata,
549
- currentVersionTestUtils,
550
- version101TestUtils,
551
- version100,
552
- version100TestUtils,
553
- versionWithSlugsTestUtils,
554
- };
555
- }
556
-
557
- test('next docs', async () => {
558
- const {currentVersionTestUtils} = await loadSite();
559
-
560
- await currentVersionTestUtils.testMeta(path.join('foo', 'bar.md'), {
561
- id: 'foo/bar',
562
- unversionedId: 'foo/bar',
563
- sourceDirName: 'foo',
564
- isDocsHomePage: false,
565
- permalink: '/docs/next/foo/barSlug',
566
- slug: '/foo/barSlug',
567
- title: 'bar',
568
- description: 'This is next version of bar.',
569
- frontMatter: {slug: 'barSlug'},
570
- version: 'current',
571
- });
572
- await currentVersionTestUtils.testMeta(path.join('hello.md'), {
573
- id: 'hello',
574
- unversionedId: 'hello',
575
- sourceDirName: '.',
576
- isDocsHomePage: false,
577
- permalink: '/docs/next/hello',
578
- slug: '/hello',
579
- title: 'hello',
580
- description: 'Hello next !',
581
- frontMatter: {},
582
- version: 'current',
583
- });
584
- });
585
-
586
- test('versioned docs', async () => {
587
- const {version101TestUtils, version100TestUtils} = await loadSite();
588
-
589
- await version100TestUtils.testMeta(path.join('foo', 'bar.md'), {
590
- id: 'version-1.0.0/foo/bar',
591
- unversionedId: 'foo/bar',
592
- sourceDirName: 'foo',
593
- isDocsHomePage: false,
594
- permalink: '/docs/1.0.0/foo/barSlug',
595
- slug: '/foo/barSlug',
596
- title: 'bar',
597
- description: 'Bar 1.0.0 !',
598
- frontMatter: {slug: 'barSlug'},
599
- version: '1.0.0',
600
- });
601
- await version100TestUtils.testMeta(path.join('hello.md'), {
602
- id: 'version-1.0.0/hello',
603
- unversionedId: 'hello',
604
- sourceDirName: '.',
605
- isDocsHomePage: false,
606
- permalink: '/docs/1.0.0/hello',
607
- slug: '/hello',
608
- title: 'hello',
609
- description: 'Hello 1.0.0 ! (translated en)',
610
- frontMatter: {},
611
- version: '1.0.0',
612
- source:
613
- '@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
614
- });
615
- await version101TestUtils.testMeta(path.join('foo', 'bar.md'), {
616
- id: 'version-1.0.1/foo/bar',
617
- unversionedId: 'foo/bar',
618
- sourceDirName: 'foo',
619
- isDocsHomePage: false,
620
- permalink: '/docs/foo/bar',
621
- slug: '/foo/bar',
622
- title: 'bar',
623
- description: 'Bar 1.0.1 !',
624
- version: '1.0.1',
625
- frontMatter: {},
626
- });
627
- await version101TestUtils.testMeta(path.join('hello.md'), {
628
- id: 'version-1.0.1/hello',
629
- unversionedId: 'hello',
630
- sourceDirName: '.',
631
- isDocsHomePage: false,
632
- permalink: '/docs/hello',
633
- slug: '/hello',
634
- title: 'hello',
635
- description: 'Hello 1.0.1 !',
636
- version: '1.0.1',
637
- frontMatter: {},
638
- });
639
- });
640
-
641
- test('next doc slugs', async () => {
642
- const {currentVersionTestUtils} = await loadSite();
643
-
644
- await currentVersionTestUtils.testSlug(
645
- path.join('slugs', 'absoluteSlug.md'),
646
- '/docs/next/absoluteSlug',
647
- );
648
- await currentVersionTestUtils.testSlug(
649
- path.join('slugs', 'relativeSlug.md'),
650
- '/docs/next/slugs/relativeSlug',
651
- );
652
- await currentVersionTestUtils.testSlug(
653
- path.join('slugs', 'resolvedSlug.md'),
654
- '/docs/next/slugs/hey/resolvedSlug',
655
- );
656
- await currentVersionTestUtils.testSlug(
657
- path.join('slugs', 'tryToEscapeSlug.md'),
658
- '/docs/next/tryToEscapeSlug',
659
- );
660
- });
661
-
662
- test('versioned doc slugs', async () => {
663
- const {versionWithSlugsTestUtils} = await loadSite();
664
-
665
- await versionWithSlugsTestUtils.testSlug(
666
- path.join('rootAbsoluteSlug.md'),
667
- '/docs/withSlugs/rootAbsoluteSlug',
668
- );
669
- await versionWithSlugsTestUtils.testSlug(
670
- path.join('rootRelativeSlug.md'),
671
- '/docs/withSlugs/rootRelativeSlug',
672
- );
673
- await versionWithSlugsTestUtils.testSlug(
674
- path.join('rootResolvedSlug.md'),
675
- '/docs/withSlugs/hey/rootResolvedSlug',
676
- );
677
- await versionWithSlugsTestUtils.testSlug(
678
- path.join('rootTryToEscapeSlug.md'),
679
- '/docs/withSlugs/rootTryToEscapeSlug',
680
- );
681
-
682
- await versionWithSlugsTestUtils.testSlug(
683
- path.join('slugs', 'absoluteSlug.md'),
684
- '/docs/withSlugs/absoluteSlug',
685
- );
686
- await versionWithSlugsTestUtils.testSlug(
687
- path.join('slugs', 'relativeSlug.md'),
688
- '/docs/withSlugs/slugs/relativeSlug',
689
- );
690
- await versionWithSlugsTestUtils.testSlug(
691
- path.join('slugs', 'resolvedSlug.md'),
692
- '/docs/withSlugs/slugs/hey/resolvedSlug',
693
- );
694
- await versionWithSlugsTestUtils.testSlug(
695
- path.join('slugs', 'tryToEscapeSlug.md'),
696
- '/docs/withSlugs/tryToEscapeSlug',
697
- );
698
- });
699
-
700
- test('doc with editUrl function', async () => {
701
- const hardcodedEditUrl = 'hardcoded-edit-url';
702
-
703
- const editUrlFunction: EditUrlFunction = jest.fn(() => hardcodedEditUrl);
704
-
705
- const {siteDir, context, options, version100} = await loadSite({
706
- options: {
707
- editUrl: editUrlFunction,
708
- },
709
- });
710
-
711
- const testUtilsLocal = createTestUtils({
712
- siteDir,
713
- context,
714
- options,
715
- versionMetadata: version100,
716
- });
717
-
718
- await testUtilsLocal.testMeta(path.join('hello.md'), {
719
- id: 'version-1.0.0/hello',
720
- unversionedId: 'hello',
721
- sourceDirName: '.',
722
- isDocsHomePage: false,
723
- permalink: '/docs/1.0.0/hello',
724
- slug: '/hello',
725
- title: 'hello',
726
- description: 'Hello 1.0.0 ! (translated en)',
727
- frontMatter: {},
728
- version: '1.0.0',
729
- source:
730
- '@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
731
- editUrl: hardcodedEditUrl,
732
- });
733
-
734
- expect(editUrlFunction).toHaveBeenCalledTimes(1);
735
- expect(editUrlFunction).toHaveBeenCalledWith({
736
- version: '1.0.0',
737
- versionDocsDirPath: 'versioned_docs/version-1.0.0',
738
- docPath: path.join('hello.md'),
739
- permalink: '/docs/1.0.0/hello',
740
- locale: 'en',
741
- });
742
- });
743
-
744
- test('translated doc with editUrl', async () => {
745
- const {siteDir, context, options, version100} = await loadSite({
746
- options: {
747
- editUrl: 'https://github.com/facebook/docusaurus/edit/master/website',
748
- // editCurrentVersion: true,
749
- },
750
- });
751
-
752
- const testUtilsLocal = createTestUtils({
753
- siteDir,
754
- context,
755
- options,
756
- versionMetadata: version100,
757
- });
758
-
759
- await testUtilsLocal.testMeta(path.join('hello.md'), {
760
- id: 'version-1.0.0/hello',
761
- unversionedId: 'hello',
762
- sourceDirName: '.',
763
- isDocsHomePage: false,
764
- permalink: '/docs/1.0.0/hello',
765
- slug: '/hello',
766
- title: 'hello',
767
- description: 'Hello 1.0.0 ! (translated en)',
768
- frontMatter: {},
769
- version: '1.0.0',
770
- source:
771
- '@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
772
- editUrl:
773
- 'https://github.com/facebook/docusaurus/edit/master/website/versioned_docs/version-1.0.0/hello.md',
774
- });
775
- });
776
-
777
- test('translated en doc with editUrl and editCurrentVersion=true', async () => {
778
- const {siteDir, context, options, version100} = await loadSite({
779
- options: {
780
- editUrl: 'https://github.com/facebook/docusaurus/edit/master/website',
781
- editCurrentVersion: true,
782
- },
783
- });
784
-
785
- const testUtilsLocal = createTestUtils({
786
- siteDir,
787
- context,
788
- options,
789
- versionMetadata: version100,
790
- });
791
-
792
- await testUtilsLocal.testMeta(path.join('hello.md'), {
793
- id: 'version-1.0.0/hello',
794
- unversionedId: 'hello',
795
- sourceDirName: '.',
796
- isDocsHomePage: false,
797
- permalink: '/docs/1.0.0/hello',
798
- slug: '/hello',
799
- title: 'hello',
800
- description: 'Hello 1.0.0 ! (translated en)',
801
- frontMatter: {},
802
- version: '1.0.0',
803
- source:
804
- '@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
805
- editUrl:
806
- 'https://github.com/facebook/docusaurus/edit/master/website/docs/hello.md',
807
- });
808
- });
809
-
810
- test('translated fr doc with editUrl and editLocalizedFiles=true', async () => {
811
- const {siteDir, context, options, version100} = await loadSite({
812
- options: {
813
- editUrl: 'https://github.com/facebook/docusaurus/edit/master/website',
814
- editLocalizedFiles: true,
815
- },
816
- locale: 'fr',
817
- });
818
-
819
- const testUtilsLocal = createTestUtils({
820
- siteDir,
821
- context,
822
- options,
823
- versionMetadata: version100,
824
- });
825
-
826
- await testUtilsLocal.testMeta(path.join('hello.md'), {
827
- id: 'version-1.0.0/hello',
828
- unversionedId: 'hello',
829
- sourceDirName: '.',
830
- isDocsHomePage: false,
831
- permalink: '/fr/docs/1.0.0/hello',
832
- slug: '/hello',
833
- title: 'hello',
834
- description: 'Hello 1.0.0 ! (translated fr)',
835
- frontMatter: {},
836
- version: '1.0.0',
837
- source:
838
- '@site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
839
- editUrl:
840
- 'https://github.com/facebook/docusaurus/edit/master/website/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
841
- });
842
- });
843
-
844
- test('translated fr doc with editUrl and editLocalizedFiles=true + editCurrentVersion=true', async () => {
845
- const {siteDir, context, options, version100} = await loadSite({
846
- options: {
847
- editUrl: 'https://github.com/facebook/docusaurus/edit/master/website',
848
- editCurrentVersion: true,
849
- editLocalizedFiles: true,
850
- },
851
- locale: 'fr',
852
- });
853
-
854
- const testUtilsLocal = createTestUtils({
855
- siteDir,
856
- context,
857
- options,
858
- versionMetadata: version100,
859
- });
860
-
861
- await testUtilsLocal.testMeta(path.join('hello.md'), {
862
- id: 'version-1.0.0/hello',
863
- unversionedId: 'hello',
864
- sourceDirName: '.',
865
- isDocsHomePage: false,
866
- permalink: '/fr/docs/1.0.0/hello',
867
- slug: '/hello',
868
- title: 'hello',
869
- description: 'Hello 1.0.0 ! (translated fr)',
870
- frontMatter: {},
871
- version: '1.0.0',
872
- source:
873
- '@site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
874
- editUrl:
875
- 'https://github.com/facebook/docusaurus/edit/master/website/i18n/fr/docusaurus-plugin-content-docs/current/hello.md',
876
- });
877
- });
878
- });