Skip to content

atoms-studio/nuxt-swiftsearch / .agents/skills/create-docs

create-docs

Verified

Create 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.

FileKindSize
SKILL.mdskill md12.1 KB
references/mdc-components.mdmarkdown5.4 KB
references/templates.mdmarkdown6.0 KB
references/writing-guide.mdmarkdown2.9 KB

references/mdc-components.md

View on GitHub
# MDC Components Reference

Docus uses Nuxt UI components with MDC syntax.

**CRITICAL: Always use the `u-` prefix for Nuxt UI components in MDC:**

```markdown
::u-page-hero ✅ Correct (resolves to UPageHero)
::page-hero ❌ Wrong (fails to resolve)
```

---

## Documentation Sources

**Components:**

- Component list: https://ui.nuxt.com/llms.txt
- Raw docs: `https://ui.nuxt.com/raw/docs/components/[component].md`

**Typography/Prose:**

- Introduction: https://ui.nuxt.com/raw/docs/typography.md
- Headers and text: https://ui.nuxt.com/raw/docs/typography/headers-and-text.md
- Lists and tables: https://ui.nuxt.com/raw/docs/typography/lists-and-tables.md
- Code blocks: https://ui.nuxt.com/raw/docs/typography/code-blocks.md
- Callouts: https://ui.nuxt.com/raw/docs/typography/callouts.md
- Accordion: https://ui.nuxt.com/raw/docs/typography/accordion.md
- Tabs: https://ui.nuxt.com/raw/docs/typography/tabs.md

---

## Page Layout Components

Most used components for documentation sites:

| Component        | Raw Docs                                                                   | Use For                |
| ---------------- | -------------------------------------------------------------------------- | ---------------------- |
| `u-page-hero`    | [page-hero.md](https://ui.nuxt.com/raw/docs/components/page-hero.md)       | Landing page hero      |
| `u-page-section` | [page-section.md](https://ui.nuxt.com/raw/docs/components/page-section.md) | Content sections       |
| `u-page-grid`    | [page-grid.md](https://ui.nuxt.com/raw/docs/components/page-grid.md)       | Responsive grid layout |
| `u-page-card`    | [page-card.md](https://ui.nuxt.com/raw/docs/components/page-card.md)       | Rich content cards     |
| `u-page-feature` | [page-feature.md](https://ui.nuxt.com/raw/docs/components/page-feature.md) | Feature showcase       |
| `u-page-cta`     | [page-cta.md](https://ui.nuxt.com/raw/docs/components/page-cta.md)         | Call to action         |
| `u-page-header`  | [page-header.md](https://ui.nuxt.com/raw/docs/components/page-header.md)   | Page headers           |

---

## Quick Syntax Examples

### Hero with Buttons

```markdown
::u-page-hero
#title
Project Name

#description
Short description

#headline
:::u-button{size="sm" to="/changelog" variant="outline"}
v1.0.0 →
:::

#links
:::u-button{color="neutral" size="xl" to="/getting-started" trailing-icon="i-lucide-arrow-right"}
Get Started
:::

:::u-button{color="neutral" size="xl" to="https://github.com/..." target="\_blank" variant="outline" icon="i-simple-icons-github"}
GitHub
:::
::
```

### Grid with Cards

```markdown
::u-page-section
:::u-page-grid
::::u-page-card{spotlight class="col-span-2 lg:col-span-1" to="/feature"}
#title
Feature Title

    #description
    Feature description
    ::::

    ::::u-page-card{spotlight class="col-span-2"}
      :::::u-color-mode-image{alt="Screenshot" class="w-full rounded-lg" dark="/images/dark.png" light="/images/light.png"}
      :::::

    #title
    Visual Feature

    #description
    With light/dark mode images
    ::::

:::
::
```

### Card with Code Block

````markdown
::::u-page-card{spotlight class="col-span-2 md:col-span-1"}
:::::div{.bg-elevated.rounded-lg.p-3}

```ts [config.ts]
export default {
  option: "value",
};
```
````

:::::

#title
Configuration

#description
Easy to configure
::::

````

---

## Content Components

| Component | Raw Docs | Use For |
|-----------|----------|---------|
| `code-group` | N/A (Nuxt Content) | Multi-tab code blocks |
| `steps` | N/A (Nuxt Content) | Step-by-step guides |
| `tabs` | [tabs.md](https://ui.nuxt.com/raw/docs/components/tabs.md) | Tabbed content |
| `accordion` | [accordion.md](https://ui.nuxt.com/raw/docs/components/accordion.md) | Collapsible sections |

### Code Group (Nuxt Content)

```markdown
::code-group
```ts [nuxt.config.ts]
export default defineNuxtConfig({})
````

```ts [app.config.ts]
export default defineAppConfig({});
```

::

````

### Steps (Nuxt Content)

```markdown
::steps
### Install

Run the install command.

### Configure

Add your configuration.

### Use

Start using the feature.
::
````

---

## Callout Components

| Component   | Use For                |
| ----------- | ---------------------- |
| `::note`    | Additional information |
| `::tip`     | Helpful suggestions    |
| `::warning` | Important cautions     |
| `::caution` | Critical warnings      |

```markdown
::note{title="Custom Title"}
Additional context here.
::

::tip
Pro tip content.
::

::warning
Be careful with this.
::

::caution
This action cannot be undone.
::
```

---

## Images

### Color Mode Image

```markdown
:u-color-mode-image{alt="Feature" dark="/images/dark.png" light="/images/light.png" class="rounded-lg" width="859" height="400"}
```

---

## Grid Classes Reference

| Class                      | Usage                     |
| -------------------------- | ------------------------- |
| `col-span-2`               | Full width                |
| `col-span-2 lg:col-span-1` | Full mobile, half desktop |
| `col-span-2 md:col-span-1` | Full mobile, half tablet+ |

---

## Full Documentation Reference

- **All components**: https://ui.nuxt.com/llms.txt
- **Full docs (for LLMs)**: https://ui.nuxt.com/llms-full.txt
- **Typography introduction**: https://ui.nuxt.com/raw/docs/typography.md
- **Content integration**: https://ui.nuxt.com/raw/docs/getting-started/integrations/content.md
- **Theme customization**: https://ui.nuxt.com/raw/docs/getting-started/theme/components.md
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: 471kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexUnverifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall