atoms-studio/nuxt-swiftsearch / .agents/skills/create-docs
create-docs
VerifiedCreate complete documentation sites for projects. Use when asked to: "create docs", "add documentation", "setup docs site", "generate docs", "document my project", "write docs", "initialize documentation", "add a docs folder", "create a docs website". Generates Docus-based sites with search, dark mode, MCP server, and llms.txt integration.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 12.1 KB |
| references/mdc-components.md | markdown | 5.4 KB |
| references/templates.md | markdown | 6.0 KB |
| references/writing-guide.md | markdown | 2.9 KB |
references/templates.md
View on GitHub# Documentation Templates
Ready-to-use templates for generating documentation pages.
**CRITICAL: All Nuxt UI components must use the `u-` prefix in MDC syntax.**
- `::u-page-hero` not `::page-hero`
- `:::u-button` not `:::button`
- `::::u-page-card` not `::::page-card`
## Table of Contents
- [Landing Page](#landing-page)
- [Introduction Page](#introduction-page)
- [Installation Page](#installation-page)
- [Guide Page](#guide-page)
- [Navigation YAML](#navigation-yaml)
---
## Landing Page
### Basic Landing Page
```markdown
---
seo:
title: [Project Name] Documentation
description: [Project description]
---
::u-page-hero
#title
[Project Name]
#description
[Short description - what problem does it solve?]
#links
:::u-button
---
color: neutral
size: xl
to: /getting-started/introduction
trailing-icon: i-lucide-arrow-right
---
Get Started
:::
:::u-button
---
color: neutral
icon: i-simple-icons-github
size: xl
to: [GitHub URL]
target: \_blank
variant: outline
---
View on GitHub
:::
::
::u-page-section
#title
What you can do
#features
:::u-page-feature
---
icon: [icon]
to: /guide/[topic]
---
#title
[Action verb] [thing]
#description
[One sentence describing the capability]
:::
::
```
### Advanced Landing Page with Grid Cards
Use `u-page-grid` + `u-page-card` for rich feature showcases:
```markdown
::u-page-hero
#title
[Project Name]
#description
[Description]
#headline
:::u-button
---
size: sm
to: [changelog-url]
variant: outline
---
v1.0.0 Released →
:::
#links
:::u-button
---
color: neutral
size: xl
to: /getting-started
trailing-icon: i-lucide-arrow-right
---
Get Started
:::
::
::u-page-section
:::u-page-grid
::::u-page-card
---
spotlight: true
class: col-span-2 lg:col-span-1
to: /guide/feature-1
---
#title
Feature One
#description
Description of this feature and what it enables.
::::
::::u-page-card
---
spotlight: true
class: col-span-2
---
:::::u-color-mode-image
---
alt: Feature screenshot
class: w-full rounded-lg
dark: /images/feature-dark.png
light: /images/feature-light.png
---
:::::
#title
Feature with Image
#description
Show off your feature with dark/light mode images.
::::
:::
::
```
### Card with Code Preview
````markdown
## ::::u-page-card
spotlight: true
class: col-span-2 md:col-span-1
---
:::::div{.bg-elevated.rounded-lg.p-3.overflow-x-auto}
```ts [config.ts]
export default {
option: "value",
};
```
````
:::::
#title
Easy Configuration
#description
Configure with simple options.
::::
````
### Card with Custom Component
Create custom components in `app/components/content/` for interactive demos:
```markdown
::::u-page-card
---
spotlight: true
class: col-span-2
---
:my-custom-demo
#title
Interactive Demo
#description
Custom Vue component embedded in card.
::::
````
### Grid Layout Classes
| Class | Usage |
| -------------------------- | ------------------------------- |
| `col-span-2` | Full width (2 columns) |
| `col-span-2 lg:col-span-1` | Full on mobile, half on desktop |
| `col-span-2 md:col-span-1` | Full on mobile, half on tablet+ |
| `min-h-[450px]` | Minimum height for tall cards |
### Optional Enhancement Patterns
Pick and choose based on project needs:
| Pattern | When to Use |
| ----------------------- | ------------------------------- |
| Code preview in card | Libraries, APIs, CLIs |
| Feature grid with icons | Projects with multiple features |
| CTA section | Drive users to action |
| Before/after code | Projects solving a pain point |
See [mdc-components.md](mdc-components.md) for component syntax.
See https://ui.nuxt.com/llms.txt for full component reference.
---
## Introduction Page
```markdown
---
title: Introduction
description: Learn what [Project Name] is and when to use it
navigation:
icon: i-lucide-house
---
[Project Name] helps you [main value proposition].
## What is [Project Name]?
[2-3 sentences explaining the project]
## What you can do
- **[Action 1]** - [Brief description]
- **[Action 2]** - [Brief description]
- **[Action 3]** - [Brief description]
## When to use [Project Name]
Use [Project Name] when you need to:
- [Use case 1]
- [Use case 2]
- [Use case 3]
```
---
## Installation Page
Use the detected package manager and show all options:
````markdown
---
title: Installation
description: How to install [Project Name]
navigation:
icon: i-lucide-download
---
## Prerequisites
[List prerequisites if any]
## How to install
::code-group
```bash [pnpm]
pnpm add [package-name]
```
````
```bash [npm]
npm install [package-name]
```
```bash [yarn]
yarn add [package-name]
```
```bash [bun]
bun add [package-name]
```
::
## How to verify installation
[Verification steps]
````
---
## Guide Page
Use action verbs in H2/H3 headings:
```markdown
---
title: [Topic]
description: [Action verb] [thing] in your [Project Name] app
navigation:
icon: [icon]
---
[One sentence overview]
## Add basic [feature]
[Explanation]
```[language] [[file-path]]
[code]
````
## Configure [feature]
[Explanation]
```[language] [[file-path]]
[code]
```
## Handle [edge case]
[Explanation]
## Next steps
- [Link to related guide]
- [Link to advanced topic]
````
**Action verbs for H2 headings:** Add, Configure, Create, Set up, Enable, Connect, Handle, Customize, Deploy, Use
---
## Navigation YAML
Each section folder needs a `.navigation.yml`:
```yaml
title: [Section Title]
icon: [icon-name]
````
### Recommended Icons by Section
| Section | Icon |
| --------------- | -------------------- |
| Getting Started | `i-lucide-rocket` |
| Guide | `i-lucide-book-open` |
| Recipes | `i-lucide-chef-hat` |
| API | `i-lucide-code` |
| Examples | `i-lucide-lightbulb` |
| Configuration | `i-lucide-settings` |
| Advanced | `i-lucide-sparkles` |
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 198k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |