@docusaurus/plugin-content-docs 2.0.0-beta.15d451942 → 2.0.0-beta.18

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 (214) hide show
  1. package/lib/categoryGeneratedIndex.d.ts +12 -0
  2. package/lib/categoryGeneratedIndex.js +35 -0
  3. package/lib/cli.d.ts +2 -2
  4. package/lib/cli.js +37 -51
  5. package/lib/client/docsClientUtils.d.ts +6 -26
  6. package/lib/client/docsClientUtils.js +28 -34
  7. package/lib/{theme/hooks/useDocs.d.ts → client/index.d.ts} +4 -3
  8. package/lib/{theme/hooks/useDocs.js → client/index.js} +28 -25
  9. package/lib/docs.d.ts +31 -4
  10. package/lib/docs.js +160 -54
  11. package/{src/__tests__/__fixtures__/simple-site/docusaurus.config.js → lib/frontMatter.d.ts} +4 -8
  12. package/lib/{docFrontMatter.js → frontMatter.js} +13 -6
  13. package/lib/globalData.d.ts +2 -2
  14. package/lib/globalData.js +32 -3
  15. package/lib/index.d.ts +4 -3
  16. package/lib/index.js +123 -136
  17. package/lib/lastUpdate.d.ts +4 -6
  18. package/lib/lastUpdate.js +22 -26
  19. package/lib/markdown/index.d.ts +3 -6
  20. package/lib/markdown/index.js +3 -3
  21. package/lib/markdown/linkify.d.ts +1 -1
  22. package/lib/markdown/linkify.js +7 -3
  23. package/lib/numberPrefix.d.ts +1 -1
  24. package/lib/numberPrefix.js +16 -21
  25. package/lib/options.d.ts +3 -5
  26. package/lib/options.js +55 -19
  27. package/lib/props.d.ts +7 -2
  28. package/lib/props.js +70 -14
  29. package/lib/routes.d.ts +28 -0
  30. package/lib/routes.js +110 -0
  31. package/lib/server-export.d.ts +8 -0
  32. package/lib/server-export.js +23 -0
  33. package/lib/{sidebarItemsGenerator.d.ts → sidebars/generator.d.ts} +1 -6
  34. package/lib/sidebars/generator.js +209 -0
  35. package/lib/sidebars/index.d.ts +13 -0
  36. package/lib/sidebars/index.js +94 -0
  37. package/lib/sidebars/normalization.d.ts +13 -0
  38. package/lib/sidebars/normalization.js +55 -0
  39. package/lib/sidebars/postProcessor.d.ts +8 -0
  40. package/lib/sidebars/postProcessor.js +65 -0
  41. package/lib/sidebars/processor.d.ts +10 -0
  42. package/lib/sidebars/processor.js +79 -0
  43. package/lib/sidebars/types.d.ts +174 -0
  44. package/{src/__tests__/__fixtures__/site-with-autogenerated-sidebar/partialAutogeneratedSidebars2.js → lib/sidebars/types.js} +2 -10
  45. package/lib/sidebars/utils.d.ts +54 -0
  46. package/lib/sidebars/utils.js +255 -0
  47. package/lib/sidebars/validation.d.ts +11 -0
  48. package/lib/sidebars/validation.js +138 -0
  49. package/lib/slug.d.ts +6 -4
  50. package/lib/slug.js +29 -19
  51. package/{src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docusaurus.config.js → lib/tags.d.ts} +2 -8
  52. package/lib/tags.js +21 -0
  53. package/lib/translations.d.ts +2 -2
  54. package/lib/translations.js +89 -49
  55. package/lib/types.d.ts +60 -130
  56. package/lib/versions.d.ts +29 -4
  57. package/lib/versions.js +134 -97
  58. package/package.json +30 -26
  59. package/src/categoryGeneratedIndex.ts +55 -0
  60. package/src/cli.ts +47 -63
  61. package/src/client/docsClientUtils.ts +38 -73
  62. package/src/{theme/hooks/useDocs.ts → client/index.ts} +16 -11
  63. package/{types.d.ts → src/deps.d.ts} +1 -1
  64. package/src/docs.ts +212 -46
  65. package/src/{docFrontMatter.ts → frontMatter.ts} +21 -26
  66. package/src/globalData.ts +53 -3
  67. package/src/index.ts +168 -178
  68. package/src/lastUpdate.ts +26 -33
  69. package/src/markdown/index.ts +10 -16
  70. package/src/markdown/linkify.ts +6 -2
  71. package/src/numberPrefix.ts +19 -26
  72. package/src/options.ts +60 -32
  73. package/src/plugin-content-docs.d.ts +263 -40
  74. package/src/props.ts +105 -21
  75. package/src/routes.ts +185 -0
  76. package/src/server-export.ts +24 -0
  77. package/src/sidebars/README.md +9 -0
  78. package/src/sidebars/generator.ts +292 -0
  79. package/src/sidebars/index.ts +120 -0
  80. package/src/sidebars/normalization.ts +85 -0
  81. package/src/sidebars/postProcessor.ts +89 -0
  82. package/src/sidebars/processor.ts +120 -0
  83. package/src/sidebars/types.ts +274 -0
  84. package/src/sidebars/utils.ts +388 -0
  85. package/src/sidebars/validation.ts +174 -0
  86. package/src/slug.ts +40 -23
  87. package/src/tags.ts +19 -0
  88. package/src/translations.ts +124 -66
  89. package/src/types.ts +67 -187
  90. package/src/versions.ts +205 -110
  91. package/lib/.tsbuildinfo +0 -4717
  92. package/lib/docFrontMatter.d.ts +0 -21
  93. package/lib/sidebarItemsGenerator.js +0 -211
  94. package/lib/sidebars.d.ts +0 -42
  95. package/lib/sidebars.js +0 -309
  96. package/src/__tests__/__fixtures__/bad-id-site/docs/invalid-id.md +0 -5
  97. package/src/__tests__/__fixtures__/bad-slug-on-doc-home-site/docs/docWithSlug.md +0 -5
  98. package/src/__tests__/__fixtures__/empty-site/docusaurus.config.js +0 -16
  99. package/src/__tests__/__fixtures__/empty-site/sidebars.json +0 -1
  100. package/src/__tests__/__fixtures__/sidebars/sidebars-category-shorthand.js +0 -34
  101. package/src/__tests__/__fixtures__/sidebars/sidebars-category-wrong-items.json +0 -11
  102. package/src/__tests__/__fixtures__/sidebars/sidebars-category-wrong-label.json +0 -11
  103. package/src/__tests__/__fixtures__/sidebars/sidebars-category.js +0 -44
  104. package/src/__tests__/__fixtures__/sidebars/sidebars-collapsed-first-level.json +0 -20
  105. package/src/__tests__/__fixtures__/sidebars/sidebars-collapsed.json +0 -21
  106. package/src/__tests__/__fixtures__/sidebars/sidebars-doc-id-not-string.json +0 -10
  107. package/src/__tests__/__fixtures__/sidebars/sidebars-first-level-not-category.js +0 -20
  108. package/src/__tests__/__fixtures__/sidebars/sidebars-link-wrong-href.json +0 -11
  109. package/src/__tests__/__fixtures__/sidebars/sidebars-link-wrong-label.json +0 -11
  110. package/src/__tests__/__fixtures__/sidebars/sidebars-link.json +0 -11
  111. package/src/__tests__/__fixtures__/sidebars/sidebars-unknown-type.json +0 -14
  112. package/src/__tests__/__fixtures__/sidebars/sidebars-wrong-field.json +0 -20
  113. package/src/__tests__/__fixtures__/sidebars/sidebars.json +0 -20
  114. package/src/__tests__/__fixtures__/simple-site/docs/foo/bar.md +0 -69
  115. package/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md +0 -67
  116. package/src/__tests__/__fixtures__/simple-site/docs/headingAsTitle.md +0 -1
  117. package/src/__tests__/__fixtures__/simple-site/docs/hello.md +0 -52
  118. package/src/__tests__/__fixtures__/simple-site/docs/ipsum.md +0 -5
  119. package/src/__tests__/__fixtures__/simple-site/docs/lorem.md +0 -6
  120. package/src/__tests__/__fixtures__/simple-site/docs/rootAbsoluteSlug.md +0 -5
  121. package/src/__tests__/__fixtures__/simple-site/docs/rootRelativeSlug.md +0 -5
  122. package/src/__tests__/__fixtures__/simple-site/docs/rootResolvedSlug.md +0 -5
  123. package/src/__tests__/__fixtures__/simple-site/docs/rootTryToEscapeSlug.md +0 -5
  124. package/src/__tests__/__fixtures__/simple-site/docs/slugs/absoluteSlug.md +0 -5
  125. package/src/__tests__/__fixtures__/simple-site/docs/slugs/relativeSlug.md +0 -5
  126. package/src/__tests__/__fixtures__/simple-site/docs/slugs/resolvedSlug.md +0 -5
  127. package/src/__tests__/__fixtures__/simple-site/docs/slugs/tryToEscapeSlug.md +0 -5
  128. package/src/__tests__/__fixtures__/simple-site/sidebars.json +0 -23
  129. package/src/__tests__/__fixtures__/simple-site/wrong-sidebars.json +0 -7
  130. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/0-getting-started.md +0 -3
  131. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/1-installation.md +0 -3
  132. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/00_api-overview.md +0 -3
  133. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/01_Core APIs/0 --- Client API.md +0 -1
  134. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/01_Core APIs/1 --- Server API.md +0 -1
  135. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/0. Plugin API.md +0 -1
  136. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/1. Theme API.md +0 -1
  137. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/_category_.yml +0 -1
  138. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/03_api-end.md +0 -3
  139. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/_category_.json +0 -3
  140. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/0-guide2.5.md +0 -8
  141. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/02-guide2.md +0 -7
  142. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/_category_.json +0 -3
  143. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/a-guide4.md +0 -7
  144. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/b-guide5.md +0 -7
  145. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/guide3.md +0 -8
  146. package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/z-guide1.md +0 -8
  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/docusaurus.config.js +0 -14
  151. package/src/__tests__/__fixtures__/site-with-doc-label/sidebars.json +0 -14
  152. package/src/__tests__/__fixtures__/versioned-site/community/team.md +0 -1
  153. package/src/__tests__/__fixtures__/versioned-site/community_sidebars.json +0 -3
  154. package/src/__tests__/__fixtures__/versioned-site/community_versioned_docs/version-1.0.0/team.md +0 -1
  155. package/src/__tests__/__fixtures__/versioned-site/community_versioned_sidebars/version-1.0.0-sidebars.json +0 -3
  156. package/src/__tests__/__fixtures__/versioned-site/community_versions.json +0 -1
  157. package/src/__tests__/__fixtures__/versioned-site/docs/foo/bar.md +0 -4
  158. package/src/__tests__/__fixtures__/versioned-site/docs/hello.md +0 -1
  159. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/absoluteSlug.md +0 -5
  160. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/relativeSlug.md +0 -5
  161. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/resolvedSlug.md +0 -5
  162. package/src/__tests__/__fixtures__/versioned-site/docs/slugs/tryToEscapeSlug.md +0 -5
  163. package/src/__tests__/__fixtures__/versioned-site/docusaurus.config.js +0 -18
  164. package/src/__tests__/__fixtures__/versioned-site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md +0 -1
  165. package/src/__tests__/__fixtures__/versioned-site/i18n/en/docusaurus-plugin-content-docs-community/current/team.md +0 -5
  166. package/src/__tests__/__fixtures__/versioned-site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md +0 -1
  167. package/src/__tests__/__fixtures__/versioned-site/sidebars.json +0 -10
  168. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/foo/bar.md +0 -4
  169. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/foo/baz.md +0 -1
  170. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/hello.md +0 -1
  171. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/foo/bar.md +0 -1
  172. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/hello.md +0 -1
  173. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootAbsoluteSlug.md +0 -5
  174. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootRelativeSlug.md +0 -5
  175. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootResolvedSlug.md +0 -5
  176. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootTryToEscapeSlug.md +0 -5
  177. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/absoluteSlug.md +0 -5
  178. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/relativeSlug.md +0 -5
  179. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/resolvedSlug.md +0 -5
  180. package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/tryToEscapeSlug.md +0 -5
  181. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.0-sidebars.json +0 -11
  182. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.1-sidebars.json +0 -10
  183. package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-withSlugs-sidebars.json +0 -5
  184. package/src/__tests__/__fixtures__/versioned-site/versions.json +0 -5
  185. package/src/__tests__/__snapshots__/cli.test.ts.snap +0 -90
  186. package/src/__tests__/__snapshots__/index.test.ts.snap +0 -1907
  187. package/src/__tests__/__snapshots__/sidebars.test.ts.snap +0 -218
  188. package/src/__tests__/__snapshots__/translations.test.ts.snap +0 -487
  189. package/src/__tests__/cli.test.ts +0 -333
  190. package/src/__tests__/docFrontMatter.test.ts +0 -204
  191. package/src/__tests__/docs.test.ts +0 -875
  192. package/src/__tests__/index.test.ts +0 -1831
  193. package/src/__tests__/lastUpdate.test.ts +0 -68
  194. package/src/__tests__/numberPrefix.test.ts +0 -199
  195. package/src/__tests__/options.test.ts +0 -232
  196. package/src/__tests__/sidebarItemsGenerator.test.ts +0 -336
  197. package/src/__tests__/sidebars.test.ts +0 -638
  198. package/src/__tests__/slug.test.ts +0 -109
  199. package/src/__tests__/translations.test.ts +0 -159
  200. package/src/__tests__/versions.test.ts +0 -718
  201. package/src/client/__tests__/docsClientUtils.test.ts +0 -372
  202. package/src/markdown/__tests__/__fixtures__/docs/doc-localized.md +0 -1
  203. package/src/markdown/__tests__/__fixtures__/docs/doc1.md +0 -13
  204. package/src/markdown/__tests__/__fixtures__/docs/doc2.md +0 -12
  205. package/src/markdown/__tests__/__fixtures__/docs/doc4.md +0 -19
  206. package/src/markdown/__tests__/__fixtures__/docs/doc5.md +0 -6
  207. package/src/markdown/__tests__/__fixtures__/docs/subdir/doc3.md +0 -3
  208. package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/doc2.md +0 -7
  209. package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/subdir/doc1.md +0 -3
  210. package/src/markdown/__tests__/__snapshots__/linkify.test.ts.snap +0 -82
  211. package/src/markdown/__tests__/linkify.test.ts +0 -190
  212. package/src/sidebarItemsGenerator.ts +0 -307
  213. package/src/sidebars.ts +0 -489
  214. 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,67 +0,0 @@
1
- ---
2
- id: baz
3
- title: baz
4
- slug: bazSlug.html
5
- ---
6
-
7
- ## Images
8
-
9
- Like links, Images also have a footnote style syntax
10
-
11
- ![Alt text][id]
12
-
13
- With a reference later in the document defining the URL location:
14
-
15
- [id]: https://octodex.github.com/images/dojocat.jpg 'The Dojocat'
16
-
17
- ## Links
18
-
19
- [link text](http://dev.nodeca.com)
20
-
21
- [link with title](http://nodeca.github.io/pica/demo/ 'title text!')
22
-
23
- Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
24
-
25
- ## Footnotes
26
-
27
- Footnote 1 link[^first].
28
-
29
- Footnote 2 link[^second].
30
-
31
- Inline footnote^[Text of inline footnote] definition.
32
-
33
- Duplicated footnote reference[^second].
34
-
35
- [^first]: Footnote **can have markup**
36
-
37
- and multiple paragraphs.
38
-
39
- [^second]: Footnote text.
40
-
41
- ## Definition lists
42
-
43
- Term 1
44
-
45
- : Definition 1 with lazy continuation.
46
-
47
- Term 2 with _inline markup_
48
-
49
- : Definition 2
50
-
51
- { some code, part of Definition 2 }
52
-
53
- Third paragraph of definition 2.
54
-
55
- _Compact style:_
56
-
57
- Term 1 ~ Definition 1
58
-
59
- Term 2 ~ Definition 2a ~ Definition 2b
60
-
61
- ## Abbreviations
62
-
63
- This is HTML abbreviation example.
64
-
65
- It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
66
-
67
- \*[HTML]: Hyper Text Markup Language
@@ -1 +0,0 @@
1
- # My heading as title
@@ -1,52 +0,0 @@
1
- ---
2
- id: hello
3
- title: Hello, World !
4
- ---
5
-
6
- Hi, Endilie here :)
7
-
8
- ## Relative links
9
-
10
- Replace this [foo](foo/bar.md)
11
-
12
- Can't replace this [file](file.md)
13
-
14
- Do not replace below
15
-
16
- ```
17
- [hello](hello.md)
18
- ```
19
-
20
- ## Blockquotes
21
-
22
- > Blockquotes can also be nested...
23
- >
24
- > > ...by using additional greater-than signs right next to each other...
25
- > >
26
- > > > ...or with spaces between arrows.
27
-
28
- ## Lists
29
-
30
- Unordered
31
-
32
- - Create a list by starting a line with `+`, `-`, or `*`
33
- - Sub-lists are made by indenting 2 spaces:
34
- - Marker character change forces new list start:
35
- - Ac tristique libero volutpat at
36
- * Facilisis in pretium nisl aliquet
37
- - Nulla volutpat aliquam velit
38
- - Very easy!
39
-
40
- Ordered
41
-
42
- 1. Lorem ipsum dolor sit amet
43
- 2. Consectetur adipiscing elit
44
- 3. Integer molestie lorem at massa
45
-
46
- 1) You can use sequential numbers...
47
- 1) ...or keep all the numbers as `1.`
48
-
49
- Start numbering with offset:
50
-
51
- 57. foo
52
- 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,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,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
- };
@@ -1,7 +0,0 @@
1
- ---
2
- id: hello-1
3
- title: Hello 1
4
- ---
5
-
6
- Hello World 1!
7
-
@@ -1,8 +0,0 @@
1
- ---
2
- id: hello-2
3
- title: Hello 2
4
- sidebar_label: Hello 2 From Doc
5
- ---
6
-
7
- Hello World 2!
8
-
@@ -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
- };