Skip to content

Commit 01c5ef5

Browse files
autofix-ci[bot]devdumpling
authored andcommitted
[autofix.ci] apply automated fixes
1 parent 5e5f11f commit 01c5ef5

14 files changed

Lines changed: 1015 additions & 400 deletions

File tree

.agents/skills/create-docs/SKILL.md

Lines changed: 54 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ Generate a complete, production-ready documentation site for any project.
2626

2727
Detect from lock files, default to npm if none found:
2828

29-
| Lock File | PM | Install | Run | Add |
30-
|-----------|------|---------|-----|-----|
31-
| `pnpm-lock.yaml` | pnpm | `pnpm install` | `pnpm run` | `pnpm add` |
32-
| `package-lock.json` | npm | `npm install` | `npm run` | `npm install` |
33-
| `yarn.lock` | yarn | `yarn install` | `yarn` | `yarn add` |
34-
| `bun.lockb` | bun | `bun install` | `bun run` | `bun add` |
29+
| Lock File | PM | Install | Run | Add |
30+
| ------------------- | ---- | -------------- | ---------- | ------------- |
31+
| `pnpm-lock.yaml` | pnpm | `pnpm install` | `pnpm run` | `pnpm add` |
32+
| `package-lock.json` | npm | `npm install` | `npm run` | `npm install` |
33+
| `yarn.lock` | yarn | `yarn install` | `yarn` | `yarn add` |
34+
| `bun.lockb` | bun | `bun install` | `bun run` | `bun add` |
3535

3636
Use `[pm]` as placeholder in commands below.
3737

@@ -56,32 +56,32 @@ Check for:
5656

5757
### Determine Docs Location
5858

59-
| Project Type | Target Directory | Workspace Entry |
60-
|--------------|------------------|-----------------|
61-
| Standard project | `./docs` | N/A |
62-
| Monorepo with `apps/` | `./apps/docs` | `apps/docs` |
63-
| Monorepo with `packages/` | `./docs` | `docs` |
64-
| Existing `docs/` folder | Ask user or `./documentation` ||
59+
| Project Type | Target Directory | Workspace Entry |
60+
| ------------------------- | ----------------------------- | --------------- |
61+
| Standard project | `./docs` | N/A |
62+
| Monorepo with `apps/` | `./apps/docs` | `apps/docs` |
63+
| Monorepo with `packages/` | `./docs` | `docs` |
64+
| Existing `docs/` folder | Ask user or `./documentation` | |
6565

6666
### Read Context Files
6767

68-
| File | Extract |
69-
|------|---------|
70-
| `README.md` | Project name, description, features, usage examples |
71-
| `package.json` | Name, description, dependencies, repository URL |
72-
| `src/` or `lib/` | Exported functions, composables for API docs |
68+
| File | Extract |
69+
| ---------------- | --------------------------------------------------- |
70+
| `README.md` | Project name, description, features, usage examples |
71+
| `package.json` | Name, description, dependencies, repository URL |
72+
| `src/` or `lib/` | Exported functions, composables for API docs |
7373

7474
### Detect i18n Requirement
7575

7676
Check if project needs multi-language docs:
7777

78-
| Indicator | Action |
79-
|-----------|--------|
80-
| `@nuxtjs/i18n` in dependencies | Use i18n template |
81-
| `locales/` or `i18n/` folder exists | Use i18n template |
82-
| Multiple language README files | Use i18n template |
83-
| User explicitly mentions multiple languages | Use i18n template |
84-
| None of the above | Use default template |
78+
| Indicator | Action |
79+
| ------------------------------------------- | -------------------- |
80+
| `@nuxtjs/i18n` in dependencies | Use i18n template |
81+
| `locales/` or `i18n/` folder exists | Use i18n template |
82+
| Multiple language README files | Use i18n template |
83+
| User explicitly mentions multiple languages | Use i18n template |
84+
| None of the above | Use default template |
8585

8686
---
8787

@@ -184,10 +184,10 @@ export default defineNuxtConfig({
184184
i18n: {
185185
locales: [
186186
{ code: 'en', language: 'en-US', name: 'English' },
187-
{ code: 'fr', language: 'fr-FR', name: 'Français' }
187+
{ code: 'fr', language: 'fr-FR', name: 'Français' },
188188
],
189-
defaultLocale: 'en'
190-
}
189+
defaultLocale: 'en',
190+
},
191191
})
192192
```
193193

@@ -257,13 +257,13 @@ Use templates from [references/templates.md](references/templates.md).
257257

258258
All Nuxt UI components in MDC must use the `u-` prefix:
259259

260-
| Correct | Wrong |
261-
|---------|-------|
262-
| `::u-page-hero` | `::page-hero` |
263-
| `::u-page-section` | `::page-section` |
260+
| Correct | Wrong |
261+
| ------------------- | ----------------- |
262+
| `::u-page-hero` | `::page-hero` |
263+
| `::u-page-section` | `::page-section` |
264264
| `:::u-page-feature` | `:::page-feature` |
265-
| `:::u-button` | `:::button` |
266-
| `::::u-page-card` | `::::page-card` |
265+
| `:::u-button` | `:::button` |
266+
| `::::u-page-card` | `::::page-card` |
267267

268268
Without the `u-` prefix, Vue will fail to resolve the components.
269269

@@ -321,9 +321,9 @@ export default defineAppConfig({
321321
description: '[Project description]',
322322
url: 'https://[docs-url]',
323323
socials: {
324-
github: '[org]/[repo]'
325-
}
326-
}
324+
github: '[org]/[repo]',
325+
},
326+
},
327327
})
328328
```
329329

@@ -336,8 +336,8 @@ If the project has a design system or brand colors, customize the docs theme.
336336
Create `app/assets/css/main.css`:
337337

338338
```css [app/assets/css/main.css]
339-
@import "tailwindcss";
340-
@import "@nuxt/ui";
339+
@import 'tailwindcss';
340+
@import '@nuxt/ui';
341341

342342
@theme static {
343343
/* Custom font */
@@ -363,8 +363,8 @@ export default defineAppConfig({
363363
url: 'https://[docs-url]',
364364
socials: {
365365
github: '[org]/[repo]',
366-
x: '@[handle]'
367-
}
366+
x: '@[handle]',
367+
},
368368
},
369369
// Customize UI components
370370
ui: {
@@ -374,10 +374,10 @@ export default defineAppConfig({
374374
},
375375
pageHero: {
376376
slots: {
377-
title: 'font-semibold sm:text-6xl'
378-
}
379-
}
380-
}
377+
title: 'font-semibold sm:text-6xl',
378+
},
379+
},
380+
},
381381
})
382382
```
383383

@@ -454,12 +454,12 @@ Let me know what you'd like to improve!
454454

455455
## Deployment
456456

457-
| Platform | Command | Output |
458-
|----------|---------|--------|
459-
| Vercel | `npx vercel --prod` | Auto-detected |
460-
| Netlify | `[pm] run generate` | `.output/public` |
457+
| Platform | Command | Output |
458+
| ---------------- | ------------------- | ---------------- |
459+
| Vercel | `npx vercel --prod` | Auto-detected |
460+
| Netlify | `[pm] run generate` | `.output/public` |
461461
| Cloudflare Pages | `[pm] run generate` | `.output/public` |
462-
| GitHub Pages | `[pm] run generate` | `.output/public` |
462+
| GitHub Pages | `[pm] run generate` | `.output/public` |
463463

464464
---
465465

@@ -468,6 +468,7 @@ Let me know what you'd like to improve!
468468
**Detected:** pnpm monorepo, package in packages/
469469

470470
**Generated structure:**
471+
471472
```
472473
docs/
473474
├── content/
@@ -491,9 +492,13 @@ docs/
491492
```
492493

493494
**Inside `authentication.md`** (action-based H2 headings):
495+
494496
```markdown
495497
## Add basic authentication
498+
496499
## Protect your routes
500+
497501
## Handle login redirects
502+
498503
## Customize the session
499504
```

.agents/skills/create-docs/references/mdc-components.md

Lines changed: 55 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,21 @@ Docus uses Nuxt UI components with MDC syntax.
55
**CRITICAL: Always use the `u-` prefix for Nuxt UI components in MDC:**
66

77
```markdown
8-
::u-page-hero ✅ Correct (resolves to UPageHero)
9-
::page-hero ❌ Wrong (fails to resolve)
8+
::u-page-hero ✅ Correct (resolves to UPageHero)
9+
::page-hero ❌ Wrong (fails to resolve)
1010
```
1111

1212
---
1313

1414
## Documentation Sources
1515

1616
**Components:**
17+
1718
- Component list: https://ui.nuxt.com/llms.txt
1819
- Raw docs: `https://ui.nuxt.com/raw/docs/components/[component].md`
1920

2021
**Typography/Prose:**
22+
2123
- Introduction: https://ui.nuxt.com/raw/docs/typography.md
2224
- Headers and text: https://ui.nuxt.com/raw/docs/typography/headers-and-text.md
2325
- Lists and tables: https://ui.nuxt.com/raw/docs/typography/lists-and-tables.md
@@ -32,15 +34,15 @@ Docus uses Nuxt UI components with MDC syntax.
3234

3335
Most used components for documentation sites:
3436

35-
| Component | Raw Docs | Use For |
36-
|-----------|----------|---------|
37-
| `u-page-hero` | [page-hero.md](https://ui.nuxt.com/raw/docs/components/page-hero.md) | Landing page hero |
38-
| `u-page-section` | [page-section.md](https://ui.nuxt.com/raw/docs/components/page-section.md) | Content sections |
39-
| `u-page-grid` | [page-grid.md](https://ui.nuxt.com/raw/docs/components/page-grid.md) | Responsive grid layout |
40-
| `u-page-card` | [page-card.md](https://ui.nuxt.com/raw/docs/components/page-card.md) | Rich content cards |
41-
| `u-page-feature` | [page-feature.md](https://ui.nuxt.com/raw/docs/components/page-feature.md) | Feature showcase |
42-
| `u-page-cta` | [page-cta.md](https://ui.nuxt.com/raw/docs/components/page-cta.md) | Call to action |
43-
| `u-page-header` | [page-header.md](https://ui.nuxt.com/raw/docs/components/page-header.md) | Page headers |
37+
| Component | Raw Docs | Use For |
38+
| ---------------- | -------------------------------------------------------------------------- | ---------------------- |
39+
| `u-page-hero` | [page-hero.md](https://ui.nuxt.com/raw/docs/components/page-hero.md) | Landing page hero |
40+
| `u-page-section` | [page-section.md](https://ui.nuxt.com/raw/docs/components/page-section.md) | Content sections |
41+
| `u-page-grid` | [page-grid.md](https://ui.nuxt.com/raw/docs/components/page-grid.md) | Responsive grid layout |
42+
| `u-page-card` | [page-card.md](https://ui.nuxt.com/raw/docs/components/page-card.md) | Rich content cards |
43+
| `u-page-feature` | [page-feature.md](https://ui.nuxt.com/raw/docs/components/page-feature.md) | Feature showcase |
44+
| `u-page-cta` | [page-cta.md](https://ui.nuxt.com/raw/docs/components/page-cta.md) | Call to action |
45+
| `u-page-header` | [page-header.md](https://ui.nuxt.com/raw/docs/components/page-header.md) | Page headers |
4446

4547
---
4648

@@ -57,29 +59,29 @@ Project Name
5759
Short description
5860

5961
#headline
60-
:::u-button{size="sm" to="/changelog" variant="outline"}
61-
v1.0.0 →
62-
:::
62+
:::u-button{size="sm" to="/changelog" variant="outline"}
63+
v1.0.0 →
64+
:::
6365

6466
#links
65-
:::u-button{color="neutral" size="xl" to="/getting-started" trailing-icon="i-lucide-arrow-right"}
66-
Get Started
67-
:::
67+
:::u-button{color="neutral" size="xl" to="/getting-started" trailing-icon="i-lucide-arrow-right"}
68+
Get Started
69+
:::
6870

69-
:::u-button{color="neutral" size="xl" to="https://github.com/..." target="_blank" variant="outline" icon="i-simple-icons-github"}
70-
GitHub
71-
:::
71+
:::u-button{color="neutral" size="xl" to="https://github.com/..." target="\_blank" variant="outline" icon="i-simple-icons-github"}
72+
GitHub
73+
:::
7274
::
7375
```
7476

7577
### Grid with Cards
7678

7779
```markdown
7880
::u-page-section
79-
:::u-page-grid
80-
::::u-page-card{spotlight class="col-span-2 lg:col-span-1" to="/feature"}
81-
#title
82-
Feature Title
81+
:::u-page-grid
82+
::::u-page-card{spotlight class="col-span-2 lg:col-span-1" to="/feature"}
83+
#title
84+
Feature Title
8385

8486
#description
8587
Feature description
@@ -95,29 +97,34 @@ Short description
9597
#description
9698
With light/dark mode images
9799
::::
98-
:::
100+
101+
:::
99102
::
100103
```
101104
102105
### Card with Code Block
103106
104-
```markdown
107+
````markdown
105108
::::u-page-card{spotlight class="col-span-2 md:col-span-1"}
106-
:::::div{.bg-elevated.rounded-lg.p-3}
107-
```ts [config.ts]
108-
export default {
109-
option: 'value'
110-
}
111-
```
112-
:::::
109+
:::::div{.bg-elevated.rounded-lg.p-3}
110+
111+
```ts [config.ts]
112+
export default {
113+
option: 'value',
114+
}
115+
```
116+
````
117+
118+
:::::
113119
114120
#title
115121
Configuration
116122
117123
#description
118124
Easy to configure
119125
::::
120-
```
126+
127+
````
121128

122129
---
123130

@@ -136,13 +143,15 @@ Easy to configure
136143
::code-group
137144
```ts [nuxt.config.ts]
138145
export default defineNuxtConfig({})
139-
```
146+
````
140147

141148
```ts [app.config.ts]
142149
export default defineAppConfig({})
143150
```
151+
144152
::
145-
```
153+
154+
````
146155

147156
### Steps (Nuxt Content)
148157

@@ -160,18 +169,18 @@ Add your configuration.
160169
161170
Start using the feature.
162171
::
163-
```
172+
````
164173
165174
---
166175
167176
## Callout Components
168177
169-
| Component | Use For |
170-
|-----------|---------|
171-
| `::note` | Additional information |
172-
| `::tip` | Helpful suggestions |
173-
| `::warning` | Important cautions |
174-
| `::caution` | Critical warnings |
178+
| Component | Use For |
179+
| ----------- | ---------------------- |
180+
| `::note` | Additional information |
181+
| `::tip` | Helpful suggestions |
182+
| `::warning` | Important cautions |
183+
| `::caution` | Critical warnings |
175184
176185
```markdown
177186
::note{title="Custom Title"}
@@ -205,9 +214,9 @@ This action cannot be undone.
205214

206215
## Grid Classes Reference
207216

208-
| Class | Usage |
209-
|-------|-------|
210-
| `col-span-2` | Full width |
217+
| Class | Usage |
218+
| -------------------------- | ------------------------- |
219+
| `col-span-2` | Full width |
211220
| `col-span-2 lg:col-span-1` | Full mobile, half desktop |
212221
| `col-span-2 md:col-span-1` | Full mobile, half tablet+ |
213222

0 commit comments

Comments
 (0)