@baybreezy/docd 0.0.8 → 0.0.9
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/LICENSE.md +21 -0
- package/README.md +99 -0
- package/package.json +1 -1
package/LICENSE.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Behon Baker
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# @baybreezy/docd
|
|
2
|
+
|
|
3
|
+
> Build beautiful documentation sites with Nuxt, Markdown, and Vue components.
|
|
4
|
+
|
|
5
|
+
[](https://npmjs.com/package/@baybreezy/docd)
|
|
6
|
+
[](https://npm.chart.dev/@baybreezy/docd)
|
|
7
|
+
[](https://npmjs.com/package/@baybreezy/docd)
|
|
8
|
+
|
|
9
|
+
## Quick Start
|
|
10
|
+
|
|
11
|
+
Scaffold a new project in seconds:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Create a new docs project
|
|
15
|
+
npx create-docd my-docs
|
|
16
|
+
|
|
17
|
+
# Navigate to your project
|
|
18
|
+
cd my-docs
|
|
19
|
+
|
|
20
|
+
# Start the dev server
|
|
21
|
+
bun run dev
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Your documentation site will be running at `http://localhost:3000`.
|
|
25
|
+
|
|
26
|
+
## What you get
|
|
27
|
+
|
|
28
|
+
A fully configured documentation site with:
|
|
29
|
+
|
|
30
|
+
- **Beautiful design** — Clean, modern theme built on [UI Thing](https://uithing.com) components
|
|
31
|
+
- **Theming** — 17 color themes with light/dark mode out of the box
|
|
32
|
+
- **Markdown enhanced** — Extended MDC syntax with interactive components and prose wrappers
|
|
33
|
+
- **Component API docs** — Automatic prop/slot/event documentation from Vue component metadata
|
|
34
|
+
- **Full-text search** — Built-in search across all your content
|
|
35
|
+
- **OG images** — Automatic Open Graph image generation
|
|
36
|
+
- **LLM-ready** — Auto-generates `llms.txt` and `llms-full.txt` for AI tool integration
|
|
37
|
+
- **MCP server** — Built-in Model Context Protocol server for Cursor, VS Code, Claude, and more
|
|
38
|
+
- **SEO** — Sitemap, robots.txt, and meta tags configured automatically
|
|
39
|
+
- **TypeScript** — Full type safety throughout
|
|
40
|
+
|
|
41
|
+
## Project structure
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
my-docs/
|
|
45
|
+
├── content/ # Your Markdown content
|
|
46
|
+
│ ├── index.md # Homepage
|
|
47
|
+
│ └── docs/ # Documentation pages
|
|
48
|
+
├── public/ # Static assets
|
|
49
|
+
└── package.json
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Docd is a Nuxt layer — you can extend it with any standard Nuxt feature:
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
my-docs/
|
|
56
|
+
├── nuxt.config.ts # Extra modules and Nuxt configuration
|
|
57
|
+
├── app/
|
|
58
|
+
│ ├── app.config.ts # Theme, navigation, and feature flags
|
|
59
|
+
│ ├── components/ # Your own Vue components (usable in Markdown)
|
|
60
|
+
│ ├── layouts/ # Custom layouts
|
|
61
|
+
│ └── pages/ # Extra pages outside of content/
|
|
62
|
+
└── server/ # Server-side code
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Configuration
|
|
66
|
+
|
|
67
|
+
Most things are controlled through `app.config.ts`:
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
export default defineAppConfig({
|
|
71
|
+
docd: {
|
|
72
|
+
ui: {
|
|
73
|
+
toc: { title: "On this page", icon: "lucide:list" },
|
|
74
|
+
borderType: "dashed",
|
|
75
|
+
transition: {
|
|
76
|
+
name: "fade",
|
|
77
|
+
duration: 0.35,
|
|
78
|
+
easing: "easeOut",
|
|
79
|
+
},
|
|
80
|
+
},
|
|
81
|
+
},
|
|
82
|
+
});
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Full configuration reference: [docd.uithing.com](https://docd.uithing.com)
|
|
86
|
+
|
|
87
|
+
## Built with
|
|
88
|
+
|
|
89
|
+
- [Nuxt](https://nuxt.com) — web framework
|
|
90
|
+
- [Nuxt Content](https://content.nuxt.com) — file-based content layer
|
|
91
|
+
- [UI Thing](https://uithing.com) — component library
|
|
92
|
+
- [Tailwind CSS](https://tailwindcss.com) — utility-first CSS
|
|
93
|
+
- [Nuxt Image](https://image.nuxt.com) — optimised image handling
|
|
94
|
+
- [nuxt-og-image](https://nuxtseo.com/og-image/getting-started/installation) — OG image generation
|
|
95
|
+
- [nuxt-llms](https://github.com/nuxt-hub/nuxt-llms) — LLM file generation
|
|
96
|
+
|
|
97
|
+
## License
|
|
98
|
+
|
|
99
|
+
Published under the [MIT](./LICENSE.md) license.
|