Use when writing blog posts or documentation markdown files - provides writing style guide (active voice, present tense), content structure patterns, and MDC component usage. Overrides brevity rules for proper grammar. Use nuxt-content for MDC syntax, nuxt-ui for component props.
The English summary is being prepared. Showing the original description.
See how to installReview the instructions the agent will receive before you install.
Writing guidance for blog posts and documentation following patterns from official Nuxt websites.
Override: When writing documentation, maintain proper grammar and complete sentences. The "sacrifice grammar for brevity" rule does NOT apply here.
Documentation must be:
Brevity is still valued, but never at the cost of clarity or correctness.
For component and syntax details, use these skills:
| Skill | Use For |
|---|---|
| nuxt-content | MDC syntax, prose components, code highlighting |
| nuxt-ui | Component props, theming, UI patterns |
| Reference | Purpose |
|---|---|
| references/writing-style.md | Voice, tone, sentence structure |
| references/content-patterns.md | Blog frontmatter, structure, component patterns |
Consider loading these reference files based on your task:
DO NOT load all files at once. Load only what's relevant to your current task.
| Pattern | Example |
|---|---|
| Subject-first | "The useFetch composable handles data fetching." |
| Imperative | "Add the following to nuxt.config.ts." |
| Contextual | "When using authentication, configure..." |
| Verb | Meaning |
|---|---|
can | Optional |
should | Recommended |
must | Required |
| Need | Component |
|---|---|
| Info aside | ::note |
| Suggestion | ::tip |
| Caution | ::warning |
| Required | ::important |
| CTA | :u-button{to="..." label="..."} |
| Multi-source code | ::code-group |
For component props: see nuxt-ui skill
#): No backticks — they don't render properlyNo reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Add, update, or retire an AI provider model option for the BYOK theme generator (OpenAI, Anthropic, Google) and verify the provider requests native structured output for it. Use when model lists go stale or a new provider/model is requested.
The English summary is being prepared. Showing the original description.
Add a new interactive design tool under /tools (like the color converter or contrast checker) — component, page, navigation, route lists, SEO, and tests. Use when building a new utility tool.
The English summary is being prepared. Showing the original description.
Write and register a new Learning Hub article (Nuxt Content markdown under content/learn) with valid frontmatter, navigation entry, route list entry, and accurate product details. Use when adding or substantially rewriting a learn guide, reference, or tip.
The English summary is being prepared. Showing the original description.
Add a new component showcase, block, or template preview page and register it everywhere it must appear (navigation, command palette, route lists, SEO, source view). Use when adding anything under /components, /blocks, or /templates.
The English summary is being prepared. Showing the original description.
Checklist for adding or changing a field on ThemeConfig (a new design token, per-mode setting, or export option) end to end — schema, defaults, store + history, CSS apply, export, editor UI, AI, and tests. Use whenever ThemeConfig's shape changes.
The English summary is being prepared. Showing the original description.
Run the project's validation pipeline (lint → format → typecheck → unit tests) with auto-fixes, then optionally stage and write a Conventional Commit. Use before committing, when asked to "check", "validate", "run the workflow", or "get this commit-ready".
The English summary is being prepared. Showing the original description.