VerifiedPlugin
Content
nuxt-studio
![npm version][npm-version-href] ![npm downloads][npm-downloads-href] ![License][license-href] Visual edition in production for your Nuxt Content website.
2 skills
@nuxt-contentDocumentation
Plugin
docus
Write beautiful documentations with Nuxt and Markdown.
Plugin Signal66/100Solid
maintained87
capable14
documented100
adopted74
Install
$ npx -y skills add nuxt-content/docus --agent claude-code
Run the curl in your terminal, the rest in Claude Code.
Stats
2,948
Stars
275
Forks
Active
Maintenance
TypeScript
Language
MIT
License
24d ago
Last commit
5y ago
Created
Repo: nuxt-content/docus
What's inside
Badges
1
README
1
Create beautiful docs with Markdown & Vue components
🚀 Quick Start
Local Development
Create a new documentation project in seconds:
# Create a new project
npx create-docus my-docs
# Or create with i18n template for multi-language docs
npx create-docus my-docs -t i18n
# Navigate to your project
cd my-docs
# Start development server
npm run dev
That's it! Your documentation site will be running at http://localhost:3000
Online Development
Start by deploying the docus template and create your git repository directly from Vercel:
🎯 What it creates
The CLI scaffolds a complete documentation project with:
- ✨ Beautiful Design - Clean, modern documentation theme built on Nuxt UI 4 & Tailwind CSS 4
- 📱 Responsive - Mobile-first responsive design
- 🌙 Dark Mode - Built-in dark/light mode with
dshortcut toggle - 🌍 Internationalization - Native i18n support with 20+ locales for assistant UI
- 🔍 Search - Client-side search with optional FTS5 full-text search backend
- 📝 Markdown Enhanced - Extended markdown with custom MDC components
- 🎨 Customizable - Theme variants, custom icons,
- ⚡ Fast - Optimized for performance with Nuxt 4
- 🔧 TypeScript - Full TypeScript support
- 🤖 AI Assistant - Drop-in chat that answers questions from your docs, cites sources, and generates code
- 🔌 Native MCP Server - Built-in Model Context Protocol server for AI tool integration (Cursor, VS Code, Claude, etc.)
- 📚 Agent Skills Discovery - Publish skills from your docs site via
.well-known/skills/ - 📄 LLM-Ready - Automatic
llms.txtandllms-full.txtgeneration - 🗺️ SEO Optimized - Sitemap, robots.txt, and OG image generation out of the box
Learn more on the Docus documentation.
🤖 AI features
Docus ships with a full AI stack to help both your users and contributors:
Assistant
Embed an AI-powered chat in your docs that answers questions, cites sources, and generates code examples. Powered by Vercel AI Gateway and your own MCP server. See the Assistant guide.
MCP Server
Every Docus site exposes an MCP server at /mcp — install it directly into your editor to query your docs from any AI tool:
Agent Skills
Drop skills into a skills/ directory and Docus serves them at /.well-known/skills/ following the Cloudflare Agent Skills Discovery RFC. Users install them with a single command:
npx skills add https://your-docs-domain.com
Get the Docus skill itself to supercharge your AI assistant when building docs:
npx skills add nuxt-content/docus
📁 Project Structure
Generated project
my-docs/
├── content/ # Your markdown content
│ ├── index.md # Homepage
│ └── docs/ # Documentation pages
├── public/ # Static assets
└── package.json # Dependencies and scripts
Optional files and folders
Docus uses a layer system, you can go further and use any feature or file of a classical Nuxt project:
my-docs/
├── app.config.ts # App configuration
├── nuxt.config.ts # Nuxt configuration (add extra modules, components, etc.)
├── app/ # App directory
│ ├── components/ # Components (add your own components)
│ ├── layouts/ # Layouts (add your own layouts)
│ └── pages/ # Pages (add your own pages)
└── server/ # Server-side code (add your own server-side code)
/content folder structure
Single language structure:
content/
├── index.md
├── getting-started.md
└── guide/
├── introduction.md
└── configuration.md
Multi-language structure (with i18n):
content/
├── en/
│ ├── index.md
│ └── guide/
│ └── introduction.md
└── fr/
├── index.md
└── guide/
└── introduction.md
⚡ Built with
Your project comes pre-configured with the best of the Nuxt ecosystem:
- Nuxt 4 - The web framework
- Nuxt Content - File-based CMS
- Nuxt UI 4 - UI components
- Nuxt Image - Optimized images
- Tailwind CSS 4 - Utility-first CSS
- Docus Layer - Documentation theme
- Nuxt i18n - Internationalization
- Nuxt LLMs -
llms.txtgeneration - Nuxt OG Image - Open Graph image generation
- MCP Toolkit - Native MCP server
- Vercel AI SDK - AI assistant (optional)
📖 Documentation
For detailed documentation on customizing your Docus project, visit the Docus Documentation
🛠️ Development
This repository contains the CLI tool source code.
Local Development
To contribute to the CLI tool:
# Clone this repository
git clone https://github.com/nuxt-content/docus
# Install dependencies
pnpm install
# Run the dev server to run the docus docs
pnpm run dev
Package Structure
This is a monorepo containing:
/cli- CLI tool (create-docus)/layer- Docus Nuxt layer (docus)/docs- Official documentation/.starters- Starters project
📄 License
Published under the MIT license.
Docus has been entirely rewritten from scratch and is inspired from undocs made by @pi0 💚
File tree
326nuxt-content/docusView on GitHub
.github/
workflows/
ci.yml
.gitignore
.nuxtrc
.release-it.cli.json
.release-it.json
.release-it.layer.json
.starters/
default/
.gitignore
content/
1.getting-started/
.navigation.yml
2.introduction.md
3.installation.md
4.project-structure.md
5.studio.md
6.migration.md
7.troubleshooting.md
2.essentials/
.navigation.yml
1.markdown-syntax.md
2.code-blocks.md
3.components.md
4.images-embeds.md
index.md
nuxt.config.ts
package.json
public/
favicon.ico
mountains.webp
README.md
tsconfig.json
i18n/
.gitignore
content/
en/
1.getting-started/
.navigation.yml
2.introduction.md
3.installation.md
4.project-structure.md
5.studio.md
6.migration.md
7.troubleshooting.md
2.essentials/
.navigation.yml
1.markdown-syntax.md
2.code-blocks.md
3.components.md
4.images-embeds.md
index.md
fr/
1.getting-started/
.navigation.yml
2.introduction.md
3.installation.md
4.project-structure.md
5.studio.md
6.migration.md
7.troubleshooting.md
2.essentials/
.navigation.yml
1.markdown-syntax.md
2.code-blocks.md
3.components.md
4.images-embeds.md
index.md
nuxt.config.ts
package.json
public/
favicon.ico
mountains.webp
README.md
tsconfig.json
CHANGELOG.md
cli/
cli.ts
main.ts
package.json
README.md
tsconfig.json
types.ts
docs/
app/
app.config.ts
app.css
components/
AppHeaderCTA.vue
AppHeaderLogo.vue
content/
AssistantDemo.vue
BrowserFrame.vue
ColorModeSwitch.vue
CommandSearch.vue
FloatingNuxt.vue
NuxtImage.vue
plugins/
vercel.client.ts
content/
en/
1.getting-started/
.navigation.yml
2.introduction.md
3.installation.md
4.project-structure.md
5.studio.md
6.migration.md
7.troubleshooting.md
2.concepts/
.navigation.yml
2.edition.md
3.configuration.md
4.theme.md
5.customization.md
6.internationalization.md
8.nuxt.md
3.essentials/
.navigation.yml
1.markdown-syntax.md
2.code-blocks.md
3.components.md
4.images-embeds.md
4.ai/
.navigation.yml
1.assistant.md
2.mcp.md
3.skills.md
4.llms.md
index.md
fr/
1.getting-started/
.navigation.yml
2.introduction.md
3.installation.md
4.project-structure.md
5.studio.md
6.migration.md
7.troubleshooting.md
2.concepts/
.navigation.yml
2.edition.md
3.configuration.md
4.theme.md
5.customization.md
6.internationalization.md
8.nuxt.md
3.essentials/
.navigation.yml
1.markdown-syntax.md
2.code-blocks.md
3.components.md
4.images-embeds.md
4.ai/
.navigation.yml
1.assistant.md
2.mcp.md
3.skills.md
4.llms.md
index.md
nuxt.config.ts
package.json
public/
documentation/
app-footer-left.webp
app-footer-right.webp
app-header-body.webp
app-header-center.webp
app-header-cta.webp
app-header-logo.webp
app-page-header-links.webp
docs-aside-left-body.webp
docs-aside-left-top.webp
docs-aside-right-bottom.webp
docs-aside-right.png
frontmatter-preview-title-description.png
markdown-editor-studio.png
mountains.webp
nuxt-studio-module-alpha.png
og-image-example.png
preview-studio.png
sub-navigation.png
visual-editor-studio.png
favicon.ico
favicon.svg
icon.png
landing/
dark/
command-menu.png
i18n.svg
mcp.svg
nuxt-image.svg
templates-ui-pro.webp
light/
command-menu.png
i18n.svg
mcp.svg
nuxt-image.svg
templates-ui-pro.webp
nuxt-logo-3D.svg
logo/
logo-dark.svg
logo-light.svg
wordmark-dark.svg
wordmark-light.svg
mountains.webp
skills/
create-docs/
references/
mdc-components.md
templates.md
writing-guide.md
SKILL.md
review-docs/
assets/
report-template.md
references/
clarity-checks.md
i18n-checks.md
seo-checks.md
structure-checks.md
technical-checks.md
SKILL.md
tsconfig.json
eslint.config.mjs
layer/
app/
app.config.ts
app.vue
assets/
icons/
ai.svg
LICENSE
components/
app/
AppFooter.vue
AppFooterLeft.vue
AppFooterRight.vue
AppHeader.vue
AppHeaderBody.vue
AppHeaderBottom.vue
AppHeaderBottomRight.vue
AppHeaderCenter.vue
AppHeaderCTA.vue
AppHeaderLeft.vue
AppHeaderLogo.vue
AppSearch.vue
docs/
DocsAsideLeftBody.vue
DocsAsideLeftTop.vue
DocsAsideMobileBar.vue
DocsAsideRight.vue
DocsAsideRightBottom.vue
DocsPageHeaderLinks.vue
IconMenuToggle.vue
LanguageSelect.vue
OgImage/
Docs.takumi.vue
Landing.takumi.vue
composables/
useDocusColorMode.ts
useDocusI18n.ts
useDocusShortcuts.ts
useLogoAssets.ts
useSeo.ts
useSubNavigation.ts
useUIConfig.ts
error.vue
layouts/
default.vue
docs.vue
middleware/
colorMode.global.ts
pages/
[[lang]]/
[...slug].vue
plugins/
i18n.ts
templates/
landing.vue
types/
index.d.ts
utils/
assistantTools.ts
navigation.ts
ogImage.ts
prerender.ts
content.config.ts
i18n/
locales/
ar.json
be.json
bg.json
bn.json
ca.json
ckb.json
cs.json
da.json
de.json
el.json
en.json
es.json
et.json
fi.json
fr.json
he.json
hi.json
hy.json
id.json
it.json
ja.json
kk.json
km.json
ko.json
ky.json
lb.json
ms.json
nb.json
nl.json
pl.json
pt-BR.json
ro.json
ru.json
si.json
sl.json
sv.json
tr.json
uk.json
ur.json
vi.json
zh-CN.json
index.d.ts
modules/
assistant/
index.ts
README.md
runtime/
components/
AssistantChat.vue
AssistantChatDisabled.vue
AssistantComark.ts
AssistantFloatingInput.vue
AssistantIndicator.vue
AssistantPanel.vue
AssistantPreStream.vue
composables/
useAssistant.ts
useHighlighter.ts
server/
api/
search.ts
types.ts
config.ts
css.ts
markdown-rewrite.ts
routing.ts
skills/
index.ts
runtime/
server/
routes/
skills-files.ts
skills-index.ts
nuxt.config.ts
nuxt.schema.ts
package.json
README.md
server/
mcp/
tools/
get-page.ts
list-pages.ts
routes/
sitemap.xml.ts
utils/
content.ts
shared/
types/
docus.d.ts
tsconfig.json
utils/
git.ts
meta.ts
pages.ts
LICENSE
package.json
playground/
app/
pages/
index.vue
content/
docs/
1.getting-started/
.navigation.yml
2.introduction.md
3.installation.md
4.project-structure.md
5.studio.md
6.migration.md
... 21 moreMore Flows by @nuxt-content.
@nuxt-contentFAQ
docus is a Claude Code plugin with 1 hand-picked skill for documentation work, indexed on Flowy. Install it with the command on its page. It includes docus-playground. Its skills do not fire on their own yet. Request auto-invocation to have Flowy route them as you prompt. Free and open source.
- What is docus?
- Write beautiful documentations with Nuxt and Markdown.
- How do I install docus?
- Run these in Claude Code: npx -y skills add nuxt-content/docus --agent claude-code. Then prompt normally.
- Does docus auto-invoke its skills?
- Not yet. It is indexed on Flowy as a plain plugin. Request auto-invocation on its page and Flowy will route its skills for you as you prompt.
- Is docus free?
- Yes. Flowy is free and open source, with nothing gated. You can read every skill in full before you install.