@docusaurus/plugin-content-docs 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17

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 (213) hide show
  1. package/lib/categoryGeneratedIndex.d.ts +12 -0
  2. package/lib/categoryGeneratedIndex.js +38 -0
  3. package/lib/cli.d.ts +2 -2
  4. package/lib/cli.js +27 -44
  5. package/lib/client/docsClientUtils.d.ts +3 -25
  6. package/lib/client/docsClientUtils.js +25 -24
  7. package/lib/{theme/hooks/useDocs.d.ts → client/index.d.ts} +1 -2
  8. package/lib/{theme/hooks/useDocs.js → client/index.js} +26 -26
  9. package/lib/docFrontMatter.d.ts +1 -1
  10. package/lib/docFrontMatter.js +9 -3
  11. package/lib/docs.d.ts +39 -3
  12. package/lib/docs.js +157 -53
  13. package/lib/globalData.d.ts +5 -1
  14. package/lib/globalData.js +35 -2
  15. package/lib/index.d.ts +4 -3
  16. package/lib/index.js +110 -144
  17. package/lib/lastUpdate.js +15 -28
  18. package/lib/markdown/index.d.ts +3 -6
  19. package/lib/markdown/index.js +3 -3
  20. package/lib/markdown/linkify.d.ts +1 -1
  21. package/lib/markdown/linkify.js +2 -2
  22. package/lib/numberPrefix.d.ts +1 -1
  23. package/lib/numberPrefix.js +9 -9
  24. package/lib/options.d.ts +3 -3
  25. package/lib/options.js +50 -10
  26. package/lib/props.d.ts +7 -2
  27. package/lib/props.js +66 -11
  28. package/lib/routes.d.ts +28 -0
  29. package/lib/routes.js +110 -0
  30. package/lib/server-export.d.ts +8 -0
  31. package/lib/server-export.js +23 -0
  32. package/lib/{sidebarItemsGenerator.d.ts → sidebars/generator.d.ts} +1 -6
  33. package/lib/sidebars/generator.js +193 -0
  34. package/lib/sidebars/index.d.ts +13 -0
  35. package/lib/sidebars/index.js +88 -0
  36. package/lib/sidebars/normalization.d.ts +13 -0
  37. package/lib/sidebars/normalization.js +55 -0
  38. package/lib/sidebars/postProcessor.d.ts +8 -0
  39. package/lib/sidebars/postProcessor.js +70 -0
  40. package/lib/sidebars/processor.d.ts +8 -0
  41. package/lib/sidebars/processor.js +79 -0
  42. package/lib/sidebars/types.d.ts +166 -0
  43. package/{src/__tests__/__fixtures__/site-with-autogenerated-sidebar/partialAutogeneratedSidebars2.js → lib/sidebars/types.js} +2 -10
  44. package/lib/sidebars/utils.d.ts +43 -0
  45. package/lib/sidebars/utils.js +259 -0
  46. package/lib/sidebars/validation.d.ts +9 -0
  47. package/lib/sidebars/validation.js +137 -0
  48. package/lib/slug.d.ts +6 -4
  49. package/lib/slug.js +28 -17
  50. package/{src/__tests__/__fixtures__/site-with-doc-label/docusaurus.config.js → lib/tags.d.ts} +2 -8
  51. package/lib/tags.js +21 -0
  52. package/lib/translations.d.ts +2 -2
  53. package/lib/translations.js +91 -49
  54. package/lib/types.d.ts +40 -126
  55. package/lib/versions.d.ts +29 -4
  56. package/lib/versions.js +92 -87
  57. package/package.json +30 -27
  58. package/src/categoryGeneratedIndex.ts +59 -0
  59. package/src/cli.ts +34 -54
  60. package/src/client/docsClientUtils.ts +32 -57
  61. package/src/{theme/hooks/useDocs.ts → client/index.ts} +11 -10
  62. package/{types.d.ts → src/deps.d.ts} +0 -0
  63. package/src/docFrontMatter.ts +12 -5
  64. package/src/docs.ts +213 -47
  65. package/src/globalData.ts +53 -2
  66. package/src/index.ts +151 -197
  67. package/src/lastUpdate.ts +14 -37
  68. package/src/markdown/index.ts +9 -13
  69. package/src/markdown/linkify.ts +1 -1
  70. package/src/numberPrefix.ts +11 -8
  71. package/src/options.ts +59 -15
  72. package/src/plugin-content-docs.d.ts +249 -54
  73. package/src/props.ts +97 -18
  74. package/src/routes.ts +185 -0
  75. package/src/server-export.ts +24 -0
  76. package/src/sidebars/README.md +9 -0
  77. package/src/sidebars/generator.ts +269 -0
  78. package/src/sidebars/index.ts +113 -0
  79. package/src/sidebars/normalization.ts +85 -0
  80. package/src/sidebars/postProcessor.ts +94 -0
  81. package/src/sidebars/processor.ts +126 -0
  82. package/src/sidebars/types.ts +273 -0
  83. package/src/sidebars/utils.ts +392 -0
  84. package/src/sidebars/validation.ts +173 -0
  85. package/src/slug.ts +39 -21
  86. package/src/tags.ts +19 -0
  87. package/src/translations.ts +121 -62
  88. package/src/types.ts +46 -183
  89. package/src/versions.ts +136 -102
  90. package/lib/.tsbuildinfo +0 -1
  91. package/lib/sidebarItemsGenerator.js +0 -211
  92. package/lib/sidebars.d.ts +0 -43
  93. package/lib/sidebars.js +0 -320
  94. package/src/__tests__/__fixtures__/bad-id-site/docs/invalid-id.md +0 -5
  95. package/src/__tests__/__fixtures__/bad-slug-on-doc-home-site/docs/docWithSlug.md +0 -5
  96. package/src/__tests__/__fixtures__/empty-site/docusaurus.config.js +0 -16
  97. package/src/__tests__/__fixtures__/empty-site/sidebars.json +0 -1
  98. package/src/__tests__/__fixtures__/sidebars/sidebars-category-shorthand.js +0 -34
  99. package/src/__tests__/__fixtures__/sidebars/sidebars-category-wrong-items.json +0 -11
  100. package/src/__tests__/__fixtures__/sidebars/sidebars-category-wrong-label.json +0 -11
  101. package/src/__tests__/__fixtures__/sidebars/sidebars-category.js +0 -44
  102. package/src/__tests__/__fixtures__/sidebars/sidebars-collapsed-first-level.json +0 -20
  103. package/src/__tests__/__fixtures__/sidebars/sidebars-collapsed.json +0 -21
  104. package/src/__tests__/__fixtures__/sidebars/sidebars-doc-id-not-string.json +0 -10
  105. package/src/__tests__/__fixtures__/sidebars/sidebars-first-level-not-category.js +0 -20
  106. package/src/__tests__/__fixtures__/sidebars/sidebars-link-wrong-href.json +0 -11
  107. package/src/__tests__/__fixtures__/sidebars/sidebars-link-wrong-label.json +0 -11
  108. package/src/__tests__/__fixtures__/sidebars/sidebars-link.json +0 -11
  109. package/src/__tests__/__fixtures__/sidebars/sidebars-unknown-type.json +0 -14
  110. package/src/__tests__/__fixtures__/sidebars/sidebars-wrong-field.json +0 -20
  111. package/src/__tests__/__fixtures__/sidebars/sidebars.json +0 -20
  112. package/src/__tests__/__fixtures__/simple-site/docs/foo/bar.md +0 -69
  113. package/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md +0 -70
  114. package/src/__tests__/__fixtures__/simple-site/docs/headingAsTitle.md +0 -1
  115. package/src/__tests__/__fixtures__/simple-site/docs/hello.md +0 -53
  116. package/src/__tests__/__fixtures__/simple-site/docs/ipsum.md +0 -5
  117. package/src/__tests__/__fixtures__/simple-site/docs/lorem.md +0 -6
  118. package/src/__tests__/__fixtures__/simple-site/docs/rootAbsoluteSlug.md +0 -5
  119. package/src/__tests__/__fixtures__/simple-site/docs/rootRelativeSlug.md +0 -5
  120. package/src/__tests__/__fixtures__/simple-site/docs/rootResolvedSlug.md +0 -5
  121. package/src/__tests__/__fixtures__/simple-site/docs/rootTryToEscapeSlug.md +0 -5
  122. package/src/__tests__/__fixtures__/simple-site/docs/slugs/absoluteSlug.md +0 -5
  123. package/src/__tests__/__fixtures__/simple-site/docs/slugs/relativeSlug.md +0 -5
  124. package/src/__tests__/__fixtures__/simple-site/docs/slugs/resolvedSlug.md +0 -5
  125. package/src/__tests__/__fixtures__/simple-site/docs/slugs/tryToEscapeSlug.md +0 -5
  126. package/src/__tests__/__fixtures__/simple-site/docusaurus.config.js +0 -14
  127. package/src/__tests__/__fixtures__/simple-site/sidebars.json +0 -23
  128. package/src/__tests__/__fixtures__/simple-site/wrong-sidebars.json +0 -7
  129. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/0-getting-started.md +0 -3
  130. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/1-installation.md +0 -3
  131. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/00_api-overview.md +0 -3
  132. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/01_Core APIs/0 --- Client API.md +0 -1
  133. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/01_Core APIs/1 --- Server API.md +0 -1
  134. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/0. Plugin API.md +0 -1
  135. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/1. Theme API.md +0 -1
  136. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/_category_.yml +0 -1
  137. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/03_api-end.md +0 -3
  138. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/_category_.json +0 -3
  139. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/0-guide2.5.md +0 -8
  140. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/02-guide2.md +0 -7
  141. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/_category_.json +0 -3
  142. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/a-guide4.md +0 -7
  143. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/b-guide5.md +0 -7
  144. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/guide3.md +0 -8
  145. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/z-guide1.md +0 -8
  146. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docusaurus.config.js +0 -14
  147. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/partialAutogeneratedSidebars.js +0 -23
  148. package/src/__tests__/__fixtures__/site-with-doc-label/docs/hello-1.md +0 -7
  149. package/src/__tests__/__fixtures__/site-with-doc-label/docs/hello-2.md +0 -8
  150. package/src/__tests__/__fixtures__/site-with-doc-label/sidebars.json +0 -14
  151. package/src/__tests__/__fixtures__/versioned-site/community/team.md +0 -1
  152. package/src/__tests__/__fixtures__/versioned-site/community_sidebars.json +0 -3
  153. package/src/__tests__/__fixtures__/versioned-site/community_versioned_docs/version-1.0.0/team.md +0 -1
  154. package/src/__tests__/__fixtures__/versioned-site/community_versioned_sidebars/version-1.0.0-sidebars.json +0 -3
  155. package/src/__tests__/__fixtures__/versioned-site/community_versions.json +0 -1
  156. package/src/__tests__/__fixtures__/versioned-site/docs/foo/bar.md +0 -4
  157. package/src/__tests__/__fixtures__/versioned-site/docs/hello.md +0 -1
  158. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/absoluteSlug.md +0 -5
  159. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/relativeSlug.md +0 -5
  160. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/resolvedSlug.md +0 -5
  161. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/tryToEscapeSlug.md +0 -5
  162. package/src/__tests__/__fixtures__/versioned-site/docusaurus.config.js +0 -18
  163. package/src/__tests__/__fixtures__/versioned-site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md +0 -1
  164. package/src/__tests__/__fixtures__/versioned-site/i18n/en/docusaurus-plugin-content-docs-community/current/team.md +0 -5
  165. package/src/__tests__/__fixtures__/versioned-site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md +0 -1
  166. package/src/__tests__/__fixtures__/versioned-site/sidebars.json +0 -10
  167. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/foo/bar.md +0 -4
  168. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/foo/baz.md +0 -1
  169. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/hello.md +0 -1
  170. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/foo/bar.md +0 -1
  171. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/hello.md +0 -1
  172. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootAbsoluteSlug.md +0 -5
  173. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootRelativeSlug.md +0 -5
  174. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootResolvedSlug.md +0 -5
  175. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootTryToEscapeSlug.md +0 -5
  176. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/absoluteSlug.md +0 -5
  177. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/relativeSlug.md +0 -5
  178. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/resolvedSlug.md +0 -5
  179. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/tryToEscapeSlug.md +0 -5
  180. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.0-sidebars.json +0 -11
  181. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.1-sidebars.json +0 -10
  182. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-withSlugs-sidebars.json +0 -5
  183. package/src/__tests__/__fixtures__/versioned-site/versions.json +0 -5
  184. package/src/__tests__/__snapshots__/cli.test.ts.snap +0 -90
  185. package/src/__tests__/__snapshots__/index.test.ts.snap +0 -1916
  186. package/src/__tests__/__snapshots__/sidebars.test.ts.snap +0 -218
  187. package/src/__tests__/__snapshots__/translations.test.ts.snap +0 -487
  188. package/src/__tests__/cli.test.ts +0 -333
  189. package/src/__tests__/docFrontMatter.test.ts +0 -244
  190. package/src/__tests__/docs.test.ts +0 -878
  191. package/src/__tests__/index.test.ts +0 -1871
  192. package/src/__tests__/lastUpdate.test.ts +0 -69
  193. package/src/__tests__/numberPrefix.test.ts +0 -199
  194. package/src/__tests__/options.test.ts +0 -231
  195. package/src/__tests__/sidebarItemsGenerator.test.ts +0 -336
  196. package/src/__tests__/sidebars.test.ts +0 -639
  197. package/src/__tests__/slug.test.ts +0 -109
  198. package/src/__tests__/translations.test.ts +0 -159
  199. package/src/__tests__/versions.test.ts +0 -741
  200. package/src/client/__tests__/docsClientUtils.test.ts +0 -371
  201. package/src/markdown/__tests__/__fixtures__/docs/doc-localized.md +0 -1
  202. package/src/markdown/__tests__/__fixtures__/docs/doc1.md +0 -13
  203. package/src/markdown/__tests__/__fixtures__/docs/doc2.md +0 -12
  204. package/src/markdown/__tests__/__fixtures__/docs/doc4.md +0 -19
  205. package/src/markdown/__tests__/__fixtures__/docs/doc5.md +0 -6
  206. package/src/markdown/__tests__/__fixtures__/docs/subdir/doc3.md +0 -3
  207. package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/doc2.md +0 -7
  208. package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/subdir/doc1.md +0 -3
  209. package/src/markdown/__tests__/__snapshots__/linkify.test.ts.snap +0 -82
  210. package/src/markdown/__tests__/linkify.test.ts +0 -190
  211. package/src/sidebarItemsGenerator.ts +0 -307
  212. package/src/sidebars.ts +0 -522
  213. package/tsconfig.json +0 -9
@@ -1,44 +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
- module.exports = {
9
- docs: [
10
- {
11
- type: 'category',
12
- label: 'level 1',
13
- items: [
14
- 'a',
15
- {
16
- type: 'category',
17
- label: 'level 2',
18
- items: [
19
- {
20
- type: 'category',
21
- label: 'level 3',
22
- items: [
23
- 'c',
24
- {
25
- type: 'category',
26
- label: 'level 4',
27
- items: [
28
- 'd',
29
- {
30
- type: 'category',
31
- label: 'deeper more more',
32
- items: ['e'],
33
- },
34
- ],
35
- },
36
- ],
37
- },
38
- 'f',
39
- ],
40
- },
41
- ],
42
- },
43
- ],
44
- };
@@ -1,20 +0,0 @@
1
- {
2
- "docs": [
3
- {
4
- "type": "category",
5
- "label": "Introduction",
6
- "items": [
7
- "doc1"
8
- ],
9
- "collapsed": false
10
- },
11
- {
12
- "type": "category",
13
- "label": "Powering MDX",
14
- "items": [
15
- "doc2"
16
- ],
17
- "collapsed": false
18
- }
19
- ]
20
- }
@@ -1,21 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- {
5
- "type": "category",
6
- "label": "Introduction",
7
- "items": ["doc1"],
8
- "collapsed": false
9
- }
10
- ],
11
- "Reference": [
12
- {
13
- "type": "category",
14
- "label": "Powering MDX",
15
- "items": ["doc2"],
16
- "collapsed": false
17
- }
18
- ]
19
- }
20
- }
21
-
@@ -1,10 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- {
5
- "type": "doc",
6
- "id": ["doc1"]
7
- }
8
- ]
9
- }
10
- }
@@ -1,20 +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
- module.exports = {
9
- docs: [
10
- {
11
- type: 'category',
12
- label: 'Getting Started',
13
- items: ['greeting'],
14
- },
15
- {
16
- type: 'doc',
17
- id: 'api',
18
- },
19
- ],
20
- };
@@ -1,11 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- {
5
- "type": "link",
6
- "label": "GitHub",
7
- "href": ["example.com"]
8
- }
9
- ]
10
- }
11
- }
@@ -1,11 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- {
5
- "type": "link",
6
- "label": false,
7
- "href": "https://github.com"
8
- }
9
- ]
10
- }
11
- }
@@ -1,11 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- {
5
- "type": "link",
6
- "label": "category",
7
- "href": "https://github.com"
8
- }
9
- ]
10
- }
11
- }
@@ -1,14 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- "foo/bar",
5
- "foo/baz",
6
- {
7
- "type": "superman"
8
- }
9
- ],
10
- "Guides": [
11
- "hello"
12
- ]
13
- }
14
- }
@@ -1,20 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- "foo/bar",
5
- "foo/baz",
6
- {
7
- "type": "category",
8
- "label": "category",
9
- "href": "https://github.com"
10
- },
11
- {
12
- "type": "ref",
13
- "id": "hello"
14
- }
15
- ],
16
- "Guides": [
17
- "hello"
18
- ]
19
- }
20
- }
@@ -1,20 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- "foo/bar",
5
- "foo/baz",
6
- {
7
- "type": "link",
8
- "label": "Github",
9
- "href": "https://github.com"
10
- },
11
- {
12
- "type": "ref",
13
- "id": "hello"
14
- }
15
- ],
16
- "Guides": [
17
- "hello"
18
- ]
19
- }
20
- }
@@ -1,69 +0,0 @@
1
- ---
2
- id: bar
3
- title: Bar
4
- description: This is custom description
5
- ---
6
-
7
- # Remarkable
8
-
9
- > Experience real-time editing with Remarkable!
10
-
11
- Click the `clear` link to start with a clean slate, or get the `permalink` to share or save your results.
12
-
13
- ---
14
-
15
- # h1 Heading
16
-
17
- ## h2 Heading
18
-
19
- ### h3 Heading
20
-
21
- #### h4 Heading
22
-
23
- ##### h5 Heading
24
-
25
- ###### h6 Heading
26
-
27
- ## Horizontal Rules
28
-
29
- ---
30
-
31
- ---
32
-
33
- ---
34
-
35
- ## Typographic replacements
36
-
37
- Enable typographer option to see result.
38
-
39
- (c) (C) (r) (R) (tm) (TM) (p) (P) +-
40
-
41
- test.. test... test..... test?..... test!....
42
-
43
- !!!!!! ???? ,,
44
-
45
- Remarkable -- awesome
46
-
47
- "Smartypants, double quotes"
48
-
49
- 'Smartypants, single quotes'
50
-
51
- ## Emphasis
52
-
53
- **This is bold text**
54
-
55
- **This is bold text**
56
-
57
- _This is italic text_
58
-
59
- _This is italic text_
60
-
61
- ~~Deleted text~~
62
-
63
- Superscript: 19^th^
64
-
65
- Subscript: H~2~O
66
-
67
- ++Inserted text++
68
-
69
- ==Marked text==
@@ -1,70 +0,0 @@
1
- ---
2
- id: baz
3
- title: baz
4
- slug: bazSlug.html
5
- pagination_label: baz pagination_label
6
- ---
7
-
8
- # Baz markdown title
9
-
10
- ## Images
11
-
12
- Like links, Images also have a footnote style syntax
13
-
14
- ![Alt text][id]
15
-
16
- With a reference later in the document defining the URL location:
17
-
18
- [id]: https://octodex.github.com/images/dojocat.jpg 'The Dojocat'
19
-
20
- ## Links
21
-
22
- [link text](http://dev.nodeca.com)
23
-
24
- [link with title](http://nodeca.github.io/pica/demo/ 'title text!')
25
-
26
- Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
27
-
28
- ## Footnotes
29
-
30
- Footnote 1 link[^first].
31
-
32
- Footnote 2 link[^second].
33
-
34
- Inline footnote^[Text of inline footnote] definition.
35
-
36
- Duplicated footnote reference[^second].
37
-
38
- [^first]: Footnote **can have markup**
39
-
40
- and multiple paragraphs.
41
-
42
- [^second]: Footnote text.
43
-
44
- ## Definition lists
45
-
46
- Term 1
47
-
48
- : Definition 1 with lazy continuation.
49
-
50
- Term 2 with _inline markup_
51
-
52
- : Definition 2
53
-
54
- { some code, part of Definition 2 }
55
-
56
- Third paragraph of definition 2.
57
-
58
- _Compact style:_
59
-
60
- Term 1 ~ Definition 1
61
-
62
- Term 2 ~ Definition 2a ~ Definition 2b
63
-
64
- ## Abbreviations
65
-
66
- This is HTML abbreviation example.
67
-
68
- It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
69
-
70
- \*[HTML]: Hyper Text Markup Language
@@ -1 +0,0 @@
1
- # My heading as title
@@ -1,53 +0,0 @@
1
- ---
2
- id: hello
3
- title: Hello, World !
4
- sidebar_label: Hello sidebar_label
5
- ---
6
-
7
- Hi, Endilie here :)
8
-
9
- ## Relative links
10
-
11
- Replace this [foo](foo/bar.md)
12
-
13
- Can't replace this [file](file.md)
14
-
15
- Do not replace below
16
-
17
- ```
18
- [hello](hello.md)
19
- ```
20
-
21
- ## Blockquotes
22
-
23
- > Blockquotes can also be nested...
24
- >
25
- > > ...by using additional greater-than signs right next to each other...
26
- > >
27
- > > > ...or with spaces between arrows.
28
-
29
- ## Lists
30
-
31
- Unordered
32
-
33
- - Create a list by starting a line with `+`, `-`, or `*`
34
- - Sub-lists are made by indenting 2 spaces:
35
- - Marker character change forces new list start:
36
- - Ac tristique libero volutpat at
37
- * Facilisis in pretium nisl aliquet
38
- - Nulla volutpat aliquam velit
39
- - Very easy!
40
-
41
- Ordered
42
-
43
- 1. Lorem ipsum dolor sit amet
44
- 2. Consectetur adipiscing elit
45
- 3. Integer molestie lorem at massa
46
-
47
- 1) You can use sequential numbers...
48
- 1) ...or keep all the numbers as `1.`
49
-
50
- Start numbering with offset:
51
-
52
- 57. foo
53
- 1. bar
@@ -1,5 +0,0 @@
1
- ---
2
- custom_edit_url: null
3
- ---
4
-
5
- Lorem ipsum.
@@ -1,6 +0,0 @@
1
- ---
2
- custom_edit_url: https://github.com/customUrl/docs/lorem.md
3
- unrelated_frontmatter: won't be part of metadata
4
- ---
5
-
6
- Lorem ipsum.
@@ -1,5 +0,0 @@
1
- ---
2
- slug: /rootAbsoluteSlug
3
- ---
4
-
5
- Lorem
@@ -1,5 +0,0 @@
1
- ---
2
- slug: rootRelativeSlug
3
- ---
4
-
5
- Lorem
@@ -1,5 +0,0 @@
1
- ---
2
- slug: ./hey/ho/../rootResolvedSlug
3
- ---
4
-
5
- Lorem
@@ -1,5 +0,0 @@
1
- ---
2
- slug: ../../../../../../../../rootTryToEscapeSlug
3
- ---
4
-
5
- Lorem
@@ -1,5 +0,0 @@
1
- ---
2
- slug: /absoluteSlug
3
- ---
4
-
5
- Lorem
@@ -1,5 +0,0 @@
1
- ---
2
- slug: relativeSlug
3
- ---
4
-
5
- Lorem
@@ -1,5 +0,0 @@
1
- ---
2
- slug: ./hey/ho/../resolvedSlug
3
- ---
4
-
5
- Lorem
@@ -1,5 +0,0 @@
1
- ---
2
- slug: ../../../../../../../../tryToEscapeSlug
3
- ---
4
-
5
- Lorem
@@ -1,14 +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
- module.exports = {
9
- title: 'My Site',
10
- tagline: 'The tagline of my site',
11
- url: 'https://your-docusaurus-test-site.com',
12
- baseUrl: '/',
13
- favicon: 'img/favicon.ico',
14
- };
@@ -1,23 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- {
5
- "type": "category",
6
- "label": "foo",
7
- "items": ["foo/bar", "foo/baz"]
8
- },
9
- {
10
- "type": "link",
11
- "label": "Github",
12
- "href": "https://github.com"
13
- },
14
- {
15
- "type": "ref",
16
- "id": "hello"
17
- }
18
- ],
19
- "Guides": [
20
- "hello"
21
- ]
22
- }
23
- }
@@ -1,7 +0,0 @@
1
- {
2
- "docs": {
3
- "Test": [
4
- "goku"
5
- ]
6
- }
7
- }
@@ -1,3 +0,0 @@
1
- # Getting Started
2
-
3
- Getting started text
@@ -1,3 +0,0 @@
1
- # Installation
2
-
3
- Installation text
@@ -1 +0,0 @@
1
- label: 'Extension APIs (label from _category_.yml)'
@@ -1,3 +0,0 @@
1
- {
2
- "label": "API (label from _category_.json)"
3
- }
@@ -1,8 +0,0 @@
1
- ---
2
- id: guide2.5
3
- sidebar_position: 2.5
4
- ---
5
-
6
- # Guide 2.5
7
-
8
- Guide 2.5 text
@@ -1,7 +0,0 @@
1
- ---
2
- id: guide2
3
- ---
4
-
5
- # Guide 2
6
-
7
- Guide 2 text
@@ -1,7 +0,0 @@
1
- ---
2
- id: guide4
3
- ---
4
-
5
- # Guide 4
6
-
7
- Guide 4 text
@@ -1,7 +0,0 @@
1
- ---
2
- id: guide5
3
- ---
4
-
5
- # Guide 5
6
-
7
- Guide 5 text
@@ -1,8 +0,0 @@
1
- ---
2
- id: guide3
3
- sidebar_position: 3
4
- ---
5
-
6
- # Guide 3
7
-
8
- Guide 3 text
@@ -1,8 +0,0 @@
1
- ---
2
- id: guide1
3
- sidebar_position: 1
4
- ---
5
-
6
- # Guide 1
7
-
8
- Guide 1 text
@@ -1,14 +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
- module.exports = {
9
- title: 'My Site',
10
- tagline: 'The tagline of my site',
11
- url: 'https://your-docusaurus-test-site.com',
12
- baseUrl: '/',
13
- favicon: 'img/favicon.ico',
14
- };
@@ -1,23 +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
- module.exports = {
9
- someSidebar: [
10
- {type: 'doc', id: 'API/api-end'},
11
- {
12
- type: 'category',
13
- label: 'Some category',
14
- items: [
15
- {type: 'doc', id: 'API/api-overview'},
16
- {
17
- type: 'autogenerated',
18
- dirName: '3-API/02_Extension APIs',
19
- },
20
- ],
21
- },
22
- ],
23
- };