@docusaurus/plugin-content-docs 0.0.0-4240 → 0.0.0-4241

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 (62) hide show
  1. package/lib/.tsbuildinfo +1 -1
  2. package/lib/categoryGeneratedIndex.d.ts +12 -0
  3. package/lib/categoryGeneratedIndex.js +37 -0
  4. package/lib/cli.js +5 -23
  5. package/lib/docs.d.ts +22 -2
  6. package/lib/docs.js +71 -29
  7. package/lib/index.js +34 -62
  8. package/lib/options.js +2 -0
  9. package/lib/props.js +35 -6
  10. package/lib/routes.d.ts +27 -0
  11. package/lib/routes.js +105 -0
  12. package/lib/sidebars/generator.d.ts +2 -1
  13. package/lib/sidebars/generator.js +55 -13
  14. package/lib/sidebars/index.d.ts +5 -4
  15. package/lib/sidebars/index.js +18 -9
  16. package/lib/sidebars/normalization.d.ts +8 -3
  17. package/lib/sidebars/normalization.js +36 -17
  18. package/lib/sidebars/processor.d.ts +5 -3
  19. package/lib/sidebars/processor.js +33 -18
  20. package/lib/sidebars/types.d.ts +43 -2
  21. package/lib/sidebars/utils.d.ts +18 -6
  22. package/lib/sidebars/utils.js +149 -24
  23. package/lib/sidebars/validation.d.ts +2 -0
  24. package/lib/sidebars/validation.js +44 -8
  25. package/lib/slug.d.ts +4 -3
  26. package/lib/slug.js +26 -14
  27. package/lib/translations.js +51 -7
  28. package/lib/types.d.ts +18 -3
  29. package/package.json +8 -8
  30. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.1-sidebars.json +2 -2
  31. package/src/__tests__/__snapshots__/cli.test.ts.snap +48 -106
  32. package/src/__tests__/__snapshots__/index.test.ts.snap +279 -28
  33. package/src/__tests__/__snapshots__/translations.test.ts.snap +45 -0
  34. package/src/__tests__/docs.test.ts +122 -7
  35. package/src/__tests__/index.test.ts +27 -1
  36. package/src/__tests__/options.test.ts +2 -0
  37. package/src/__tests__/slug.test.ts +127 -20
  38. package/src/__tests__/translations.test.ts +7 -0
  39. package/src/categoryGeneratedIndex.ts +57 -0
  40. package/src/cli.ts +5 -35
  41. package/src/docs.ts +103 -45
  42. package/src/index.ts +55 -93
  43. package/src/options.ts +4 -0
  44. package/src/plugin-content-docs.d.ts +71 -8
  45. package/src/props.ts +48 -9
  46. package/src/routes.ts +173 -0
  47. package/src/sidebars/__tests__/__snapshots__/index.test.ts.snap +21 -6
  48. package/src/sidebars/__tests__/generator.test.ts +105 -1
  49. package/src/sidebars/__tests__/index.test.ts +26 -24
  50. package/src/sidebars/__tests__/processor.test.ts +110 -19
  51. package/src/sidebars/__tests__/utils.test.ts +320 -20
  52. package/src/sidebars/__tests__/validation.test.ts +105 -0
  53. package/src/sidebars/generator.ts +82 -19
  54. package/src/sidebars/index.ts +23 -13
  55. package/src/sidebars/normalization.ts +47 -23
  56. package/src/sidebars/processor.ts +57 -27
  57. package/src/sidebars/types.ts +64 -3
  58. package/src/sidebars/utils.ts +217 -42
  59. package/src/sidebars/validation.ts +52 -8
  60. package/src/slug.ts +32 -17
  61. package/src/translations.ts +74 -8
  62. package/src/types.ts +22 -5
package/src/__tests__/__snapshots__/cli.test.ts.snap CHANGED
@@ -2,122 +2,64 @@
2
2
 
3
3
  exports[`docsVersion first time versioning 1`] = `
4
4
  Object {
5
- "version-1.0.0/docs": Array [
6
- Object {
7
- "collapsed": true,
8
- "collapsible": true,
9
- "items": Array [
10
- Object {
11
- "collapsed": true,
12
- "collapsible": true,
13
- "items": Array [
14
- Object {
15
- "id": "version-1.0.0/foo/bar",
16
- "type": "doc",
17
- },
18
- Object {
19
- "id": "version-1.0.0/foo/baz",
20
- "type": "doc",
21
- },
22
- ],
23
- "label": "foo",
24
- "type": "category",
25
- },
26
- Object {
27
- "collapsed": true,
28
- "collapsible": true,
29
- "items": Array [
30
- Object {
31
- "id": "version-1.0.0/rootAbsoluteSlug",
32
- "type": "doc",
33
- },
34
- Object {
35
- "id": "version-1.0.0/rootRelativeSlug",
36
- "type": "doc",
37
- },
38
- Object {
39
- "id": "version-1.0.0/rootResolvedSlug",
40
- "type": "doc",
41
- },
42
- Object {
43
- "id": "version-1.0.0/rootTryToEscapeSlug",
44
- "type": "doc",
45
- },
46
- ],
47
- "label": "Slugs",
48
- "type": "category",
49
- },
50
- Object {
51
- "id": "version-1.0.0/headingAsTitle",
52
- "type": "doc",
53
- },
54
- Object {
55
- "href": "https://github.com",
56
- "label": "Github",
57
- "type": "link",
58
- },
59
- Object {
60
- "id": "version-1.0.0/hello",
61
- "type": "ref",
62
- },
63
- ],
64
- "label": "Test",
65
- "type": "category",
66
- },
67
- Object {
68
- "collapsed": true,
69
- "collapsible": true,
70
- "items": Array [
71
- Object {
72
- "id": "version-1.0.0/hello",
73
- "type": "doc",
74
- },
75
- ],
76
- "label": "Guides",
77
- "type": "category",
78
- },
79
- ],
5
+ "docs": Object {
6
+ "Guides": Array [
7
+ "hello",
8
+ ],
9
+ "Test": Array [
10
+ Object {
11
+ "items": Array [
12
+ "foo/bar",
13
+ "foo/baz",
14
+ ],
15
+ "label": "foo",
16
+ "type": "category",
17
+ },
18
+ Object {
19
+ "items": Array [
20
+ "rootAbsoluteSlug",
21
+ "rootRelativeSlug",
22
+ "rootResolvedSlug",
23
+ "rootTryToEscapeSlug",
24
+ ],
25
+ "label": "Slugs",
26
+ "type": "category",
27
+ },
28
+ Object {
29
+ "id": "headingAsTitle",
30
+ "type": "doc",
31
+ },
32
+ Object {
33
+ "href": "https://github.com",
34
+ "label": "Github",
35
+ "type": "link",
36
+ },
37
+ Object {
38
+ "id": "hello",
39
+ "type": "ref",
40
+ },
41
+ ],
42
+ },
80
43
  }
81
44
  `;
82
45
 
83
46
  exports[`docsVersion not the first time versioning 1`] = `
84
47
  Object {
85
- "version-2.0.0/docs": Array [
86
- Object {
87
- "collapsed": true,
88
- "collapsible": true,
89
- "items": Array [
90
- Object {
91
- "id": "version-2.0.0/foo/bar",
92
- "type": "doc",
93
- },
94
- ],
95
- "label": "Test",
96
- "type": "category",
97
- },
98
- Object {
99
- "collapsed": true,
100
- "collapsible": true,
101
- "items": Array [
102
- Object {
103
- "id": "version-2.0.0/hello",
104
- "type": "doc",
105
- },
106
- ],
107
- "label": "Guides",
108
- "type": "category",
109
- },
110
- ],
48
+ "docs": Object {
49
+ "Guides": Array [
50
+ "hello",
51
+ ],
52
+ "Test": Array [
53
+ "foo/bar",
54
+ ],
55
+ },
111
56
  }
112
57
  `;
113
58
 
114
59
  exports[`docsVersion second docs instance versioning 1`] = `
115
60
  Object {
116
- "version-2.0.0/community": Array [
117
- Object {
118
- "id": "version-2.0.0/team",
119
- "type": "doc",
120
- },
61
+ "community": Array [
62
+ "team",
121
63
  ],
122
64
  }
123
65
  `;