@docubook/create 2.3.0 → 2.5.0
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.
- package/package.json +1 -1
- package/src/dist/app/docs/[[...slug]]/page.tsx +56 -63
- package/src/dist/app/docs/layout.tsx +11 -4
- package/src/dist/app/layout.tsx +10 -9
- package/src/dist/app/page.tsx +3 -22
- package/src/dist/components/{context-popover.tsx → ContextPopover.tsx} +4 -3
- package/src/dist/components/{docs-breadcrumb.tsx → DocsBreadcrumb.tsx} +1 -1
- package/src/dist/components/{docs-menu.tsx → DocsMenu.tsx} +2 -2
- package/src/dist/components/DocsNavbar.tsx +46 -0
- package/src/dist/components/DocsSidebar.tsx +196 -0
- package/src/dist/components/Github.tsx +26 -0
- package/src/dist/components/{scroll-to-top.tsx → ScrollToTop.tsx} +16 -9
- package/src/dist/components/SearchBox.tsx +37 -0
- package/src/dist/components/SearchContext.tsx +47 -0
- package/src/dist/components/SearchModal.tsx +2 -2
- package/src/dist/components/SearchTrigger.tsx +5 -5
- package/src/dist/components/Sponsor.tsx +2 -2
- package/src/dist/components/{theme-toggle.tsx → ThemeToggle.tsx} +10 -10
- package/src/dist/components/TocObserver.tsx +197 -0
- package/src/dist/components/footer.tsx +16 -12
- package/src/dist/components/leftbar.tsx +45 -73
- package/src/dist/components/markdown/AccordionGroupMdx.tsx +1 -1
- package/src/dist/components/markdown/AccordionMdx.tsx +4 -4
- package/src/dist/components/markdown/CardMdx.tsx +4 -4
- package/src/dist/components/markdown/FileTreeMdx.tsx +4 -4
- package/src/dist/components/markdown/ImageMdx.tsx +1 -1
- package/src/dist/components/markdown/ReleaseMdx.tsx +1 -1
- package/src/dist/components/markdown/TooltipsMdx.tsx +1 -1
- package/src/dist/components/navbar.tsx +130 -53
- package/src/dist/components/sublink.tsx +1 -1
- package/src/dist/components/toc.tsx +16 -14
- package/src/dist/components/typography.tsx +1 -1
- package/src/dist/components/ui/icon-cloud.tsx +353 -0
- package/src/dist/components/ui/scroll-area.tsx +2 -2
- package/src/dist/components/ui/sheet.tsx +4 -4
- package/src/dist/components/ui/toggle.tsx +3 -3
- package/src/dist/docs/components/accordion-group.mdx +68 -0
- package/src/dist/docs/components/accordion.mdx +59 -0
- package/src/dist/docs/components/button.mdx +40 -0
- package/src/dist/docs/components/card-group.mdx +47 -0
- package/src/dist/docs/components/card.mdx +68 -0
- package/src/dist/docs/components/code-block.mdx +67 -0
- package/src/dist/docs/components/custom.mdx +38 -0
- package/src/dist/docs/components/file-tree.mdx +109 -0
- package/src/dist/docs/components/image.mdx +37 -0
- package/src/dist/docs/components/index.mdx +9 -0
- package/src/dist/docs/components/keyboard.mdx +117 -0
- package/src/dist/docs/components/link.mdx +34 -0
- package/src/dist/docs/components/note.mdx +44 -0
- package/src/dist/docs/components/release-note.mdx +114 -0
- package/src/dist/docs/components/stepper.mdx +45 -0
- package/src/dist/docs/components/tables.mdx +35 -0
- package/src/dist/docs/components/tabs.mdx +72 -0
- package/src/dist/docs/components/tooltips.mdx +22 -0
- package/src/dist/docs/components/youtube.mdx +23 -0
- package/src/dist/docs/getting-started/introduction.mdx +18 -0
- package/src/dist/docs/getting-started/quick-start-guide.mdx +60 -0
- package/src/dist/docu.json +36 -33
- package/src/dist/eslint.config.mjs +17 -30
- package/src/dist/hooks/useActiveSection.ts +34 -32
- package/src/dist/hooks/useScrollPosition.ts +16 -14
- package/src/dist/lib/markdown.ts +32 -17
- package/src/dist/lib/utils.ts +1 -1
- package/src/dist/next.config.mjs +10 -11
- package/src/dist/package.json +1 -1
- package/src/dist/styles/algolia.css +11 -9
- package/src/dist/styles/{syntax.css → override.css} +82 -39
- package/src/dist/tailwind.config.ts +11 -110
- package/src/dist/components/GithubStart.tsx +0 -44
- package/src/dist/components/mob-toc.tsx +0 -134
- package/src/dist/components/search.tsx +0 -55
- package/src/dist/components/toc-observer.tsx +0 -254
- package/src/dist/docs/api-reference/delete/index.mdx +0 -63
- package/src/dist/docs/api-reference/fetch/index.mdx +0 -63
- package/src/dist/docs/api-reference/get/index.mdx +0 -63
- package/src/dist/docs/api-reference/post/index.mdx +0 -63
- package/src/dist/docs/changelog/index.mdx +0 -49
- package/src/dist/docs/getting-started/development/index.mdx +0 -92
- package/src/dist/docs/getting-started/introduction/index.mdx +0 -92
- package/src/dist/docs/getting-started/quick-start-guide/index.mdx +0 -92
- /package/src/dist/components/{edit-on-github.tsx → EditWithGithub.tsx} +0 -0
- /package/src/dist/components/{contexts/theme-provider.tsx → ThemeProvider.tsx} +0 -0
- /package/src/dist/{components/contexts/AccordionContext.ts → lib/accordion-context.ts} +0 -0
- /package/src/dist/lib/{routes-config.ts → routes.ts} +0 -0
|
@@ -1,92 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title : Introduction
|
|
3
|
-
description : overview or synopsis of a project
|
|
4
|
-
date : 10-12-2024
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Heading 2
|
|
8
|
-
|
|
9
|
-
this is regular text written in markdown format with `inline code`, **bold**, and *italic*
|
|
10
|
-
|
|
11
|
-
### Heading 3
|
|
12
|
-
|
|
13
|
-
example of ordered list format :
|
|
14
|
-
|
|
15
|
-
- list one
|
|
16
|
-
- sub list
|
|
17
|
-
- list two
|
|
18
|
-
- list three
|
|
19
|
-
|
|
20
|
-
#### Heading 4
|
|
21
|
-
|
|
22
|
-
## Code Block
|
|
23
|
-
Below is an example of how to write a code block :
|
|
24
|
-
|
|
25
|
-
````plaintext
|
|
26
|
-
```javascript:main.js showLineNumbers {3-4}
|
|
27
|
-
function isRocketAboutToCrash() {
|
|
28
|
-
// Check if the rocket is stable
|
|
29
|
-
if (!isStable()) {
|
|
30
|
-
NoCrash(); // Prevent the crash
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
```
|
|
34
|
-
````
|
|
35
|
-
|
|
36
|
-
<Accordion title="Code Block" defaultOpen={true} icon="Code">
|
|
37
|
-
```javascript:main.js showLineNumbers {3-4}
|
|
38
|
-
function isRocketAboutToCrash() {
|
|
39
|
-
// Check if the rocket is stable
|
|
40
|
-
if (!isStable()) {
|
|
41
|
-
NoCrash(); // Prevent the crash
|
|
42
|
-
}
|
|
43
|
-
}
|
|
44
|
-
```
|
|
45
|
-
</Accordion>
|
|
46
|
-
|
|
47
|
-
## Note
|
|
48
|
-
example note :
|
|
49
|
-
```plaintext
|
|
50
|
-
<Note type="note" title="Note">
|
|
51
|
-
This is a general note to convey information to the user.
|
|
52
|
-
</Note>
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
<Note type="warning" title="Warning">
|
|
56
|
-
every page that is indexed in a folder will have an `index.mdx` file with metadata :
|
|
57
|
-
```plaintext
|
|
58
|
-
---
|
|
59
|
-
title : Introduction
|
|
60
|
-
description : overview or synopsis of a project
|
|
61
|
-
date : 10-12-2024
|
|
62
|
-
image : example-img.png
|
|
63
|
-
---
|
|
64
|
-
```
|
|
65
|
-
</Note>
|
|
66
|
-
|
|
67
|
-
## Image
|
|
68
|
-
displaying an image in markdown format :
|
|
69
|
-
|
|
70
|
-
```plaintext
|
|
71
|
-

|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
render as :
|
|
75
|
-

|
|
76
|
-
|
|
77
|
-
For a complete guide on using markdown content in DocuBook, please refer to the [Components](https://docubook.pro/docs/components) page.
|
|
78
|
-
|
|
79
|
-
## Table
|
|
80
|
-
|
|
81
|
-
### Default Table
|
|
82
|
-
|
|
83
|
-
| Property | Description | Type | Default |
|
|
84
|
-
| --- | --- | --- | --- |
|
|
85
|
-
| `title` | The title of the table | `string` | - |
|
|
86
|
-
| `description` | The description of the table | `string` | - |
|
|
87
|
-
|
|
88
|
-
### Table with Alignment
|
|
89
|
-
| Left | Center | Right |
|
|
90
|
-
| :--- | :---: | ---: |
|
|
91
|
-
| Left-aligned text | Center-aligned text | Right-aligned text |
|
|
92
|
-
| Left-aligned text | Center-aligned text | Right-aligned text |
|
|
@@ -1,92 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title : Quick Start Guide
|
|
3
|
-
description : a quick way to understand how to use it
|
|
4
|
-
date : 10-12-2024
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Heading 2
|
|
8
|
-
|
|
9
|
-
this is regular text written in markdown format with `inline code`, **bold**, and *italic*
|
|
10
|
-
|
|
11
|
-
### Heading 3
|
|
12
|
-
|
|
13
|
-
example of ordered list format :
|
|
14
|
-
|
|
15
|
-
- list one
|
|
16
|
-
- sub list
|
|
17
|
-
- list two
|
|
18
|
-
- list three
|
|
19
|
-
|
|
20
|
-
#### Heading 4
|
|
21
|
-
|
|
22
|
-
## Code Block
|
|
23
|
-
Below is an example of how to write a code block :
|
|
24
|
-
|
|
25
|
-
````plaintext
|
|
26
|
-
```javascript:main.js showLineNumbers {3-4}
|
|
27
|
-
function isRocketAboutToCrash() {
|
|
28
|
-
// Check if the rocket is stable
|
|
29
|
-
if (!isStable()) {
|
|
30
|
-
NoCrash(); // Prevent the crash
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
```
|
|
34
|
-
````
|
|
35
|
-
|
|
36
|
-
<Accordion title="Code Block" defaultOpen={true} icon="Code">
|
|
37
|
-
```javascript:main.js showLineNumbers {3-4}
|
|
38
|
-
function isRocketAboutToCrash() {
|
|
39
|
-
// Check if the rocket is stable
|
|
40
|
-
if (!isStable()) {
|
|
41
|
-
NoCrash(); // Prevent the crash
|
|
42
|
-
}
|
|
43
|
-
}
|
|
44
|
-
```
|
|
45
|
-
</Accordion>
|
|
46
|
-
|
|
47
|
-
## Note
|
|
48
|
-
example note :
|
|
49
|
-
```plaintext
|
|
50
|
-
<Note type="note" title="Note">
|
|
51
|
-
This is a general note to convey information to the user.
|
|
52
|
-
</Note>
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
<Note type="warning" title="Warning">
|
|
56
|
-
every page that is indexed in a folder will have an `index.mdx` file with metadata :
|
|
57
|
-
```plaintext
|
|
58
|
-
---
|
|
59
|
-
title : Introduction
|
|
60
|
-
description : overview or synopsis of a project
|
|
61
|
-
date : 10-12-2024
|
|
62
|
-
image : example-img.png
|
|
63
|
-
---
|
|
64
|
-
```
|
|
65
|
-
</Note>
|
|
66
|
-
|
|
67
|
-
## Image
|
|
68
|
-
displaying an image in markdown format :
|
|
69
|
-
|
|
70
|
-
```plaintext
|
|
71
|
-

|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
render as :
|
|
75
|
-

|
|
76
|
-
|
|
77
|
-
For a complete guide on using markdown content in DocuBook, please refer to the [Components](https://docubook.pro/docs/components) page.
|
|
78
|
-
|
|
79
|
-
## Table
|
|
80
|
-
|
|
81
|
-
### Default Table
|
|
82
|
-
|
|
83
|
-
| Property | Description | Type | Default |
|
|
84
|
-
| --- | --- | --- | --- |
|
|
85
|
-
| `title` | The title of the table | `string` | - |
|
|
86
|
-
| `description` | The description of the table | `string` | - |
|
|
87
|
-
|
|
88
|
-
### Table with Alignment
|
|
89
|
-
| Left | Center | Right |
|
|
90
|
-
| :--- | :---: | ---: |
|
|
91
|
-
| Left-aligned text | Center-aligned text | Right-aligned text |
|
|
92
|
-
| Left-aligned text | Center-aligned text | Right-aligned text |
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|