Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
[![npm downloads](https://img.shields.io/npm/dm/docus.svg?style=flat&colorA=020420&colorB=EEEEEE)](https://npm.chart.dev/docus)
[![License](https://img.shields.io/npm/l/docus.svg?style=flat&colorA=020420&colorB=EEEEEE)](https://npmjs.com/package/docus)

[![Install MCP in Cursor](https://mcp-toolkit.nuxt.dev/mcp/badge.svg?url=https://docus.dev/mcp)](https://docus.dev/mcp/mcp/deeplink)
[![Install MCP in VS Code](https://mcp-toolkit.nuxt.dev/mcp/badge.svg?ide=vscode&url=https://docus.dev/mcp)](https://docus.dev/mcp/mcp/deeplink?ide=vscode)

## 🚀 Quick Start

Create a new documentation project in seconds:
Expand All @@ -31,14 +34,16 @@ That's it! Your documentation site will be running at `http://localhost:3000`
The CLI scaffolds a complete documentation project with:

- ✨ **Beautiful Design** - Clean, modern documentation theme
- 📱 **Responsive** - Mobile-first responsive design
- 📱 **Responsive** - Mobile-first responsive design
- 🌙 **Dark Mode** - Built-in dark/light mode support
- 🌍 **Internationalization** - Native i18n support for multi-language docs
- 🔍 **Search** - Full-text search functionality
- 📝 **Markdown Enhanced** - Extended markdown with custom components
- 🎨 **Customizable** - Easy theming and brand customization
- ⚡ **Fast** - Optimized for performance with Nuxt 4
- 🔧 **TypeScript** - Full TypeScript support
- 🤖 **AI-Ready** - Automatic generation of `llms.txt` and `llms-full.txt` files for LLM integration
- 🔌 **Native MCP Server** - Built-in Model Context Protocol server for AI tool integration (Cursor, VS Code, Claude, etc.)

Learn more on the [Docus documentation](https://docus.dev).

Expand Down
112 changes: 81 additions & 31 deletions docs/content/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,14 @@ Ship fast, flexible, and SEO-optimized documentation with beautiful design out o
---
:::::floating-nuxt
:::::

#title
Built with [Nuxt 4]{.text-primary}
Built with [Nuxt]{.text-primary}

#description
Optimized by the most famous Vue framework. Docus gives you everything you need to build fast, performant, and SEO-friendly websites.
::::

::::u-page-card
---
spotlight: true
Expand All @@ -82,14 +82,14 @@ Ship fast, flexible, and SEO-optimized documentation with beautiful design out o
light: /landing/light/templates-ui-pro.webp
---
:::::

#title
Powered by [Nuxt UI]{.text-primary}

#description
Beautiful out of the box, minimal by design but highly customizable. Docus leverages Nuxt UI to give you the best docs writing experience with zero boilerplate, just focus on your content.
::::

::::u-page-card
---
spotlight: true
Expand All @@ -102,21 +102,21 @@ Ship fast, flexible, and SEO-optimized documentation with beautiful design out o
::::::::note{.my-0}
Here's some additional information for you.
::::::::

::::::::tip{.my-0}
Here's a helpful suggestion.
::::::::

::::::::warning{.my-0}
Be careful with this action as it might have unexpected results.
::::::::

::::::::caution{.my-0}
This action cannot be undone.
::::::::
:::::::
::::::

::::::tabs-item
---
class: mt-5 mb-2 text-xs overflow-x-auto
Expand All @@ -127,29 +127,29 @@ Ship fast, flexible, and SEO-optimized documentation with beautiful design out o
::note
Here's some additional information.
::

::tip
Here's a helpful suggestion.
::

::warning
Be careful with this action as it might have unexpected results.
::

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

#title
Enhanced Markdown syntax by [Nuxt Content]{.text-primary}

#description
The only thing you need to take care about is writing your content. Write your pages in Markdown and extend with MDC syntax to embed Nuxt UI or custom Vue components. Structure, routing, and rendering are handled for you.
::::

::::u-page-card
---
spotlight: true
Expand All @@ -172,14 +172,14 @@ Ship fast, flexible, and SEO-optimized documentation with beautiful design out o
})
```
:::::

#title
Customize with [Nuxt App Config]{.text-primary}

#description
Update colors, social links, header logos and component styles globally using the `app.config.ts`, no direct code modifications required.
::::

::::u-page-card
---
spotlight: true
Expand All @@ -188,14 +188,14 @@ Ship fast, flexible, and SEO-optimized documentation with beautiful design out o
---
:::::color-mode-switch
:::::

#title
[Nuxt Color]{.text-primary} mode

#description
Built-in dark mode provided, no configuration required.
::::

::::u-page-card
---
spotlight: true
Expand All @@ -214,14 +214,14 @@ Ship fast, flexible, and SEO-optimized documentation with beautiful design out o
loading: lazy
---
:::::

#title
Built-in navigation and [full-text search]{.text-primary}

#description
Only focus on ordering your content, Docus handles the search modal and auto-generates the side navigation for you.
::::

::::u-page-card
---
spotlight: true
Expand All @@ -231,14 +231,14 @@ Ship fast, flexible, and SEO-optimized documentation with beautiful design out o
:::::browser-frame
:video{.rounded-md controls loop playsinline src="https://res.cloudinary.com/nuxt/video/upload/v1747230893/studio/wzt9zfmdvk7hgmdx3cnt.mp4"}
:::::

#title
Collaborate on [Nuxt Studio]{.text-primary}

#description
Write and manage your content visually, with zero Markdown knowledge required. Let your non technical colleagues collaborate on the documentation and integrate Vue components without code skills.
::::

::::u-page-card
---
spotlight: true
Expand All @@ -256,12 +256,62 @@ Ship fast, flexible, and SEO-optimized documentation with beautiful design out o
---
::::::
:::::

#title
[Nuxt Image]{.text-primary} optimization

#description
Docus automatically converts Markdown images to use `<NuxtImg>` .
::::

::::u-page-card
---
spotlight: true
class: col-span-2 lg:col-span-1
target: _blank
to: /en/concepts/internationalization
---
:::::u-color-mode-image
---
height: 195
width: 403
alt: Internationalization illustration
class: w-full h-auto rounded-lg
dark: /landing/dark/i18n.svg
light: /landing/light/i18n.svg
---
:::::

#title
[Internationalization]{.text-primary} support

#description
Built-in i18n support with automatic routing and content management. Create multi-language documentation effortlessly.
::::

::::u-page-card
---
spotlight: true
class: col-span-2
target: _blank
to: /en/ai/mcp
---
:::::u-color-mode-image
---
height: 400
width: 859
alt: Native MCP server and AI-ready content illustration
class: w-full h-auto rounded-lg translate-y-10
dark: /landing/dark/mcp.svg
light: /landing/light/mcp.svg
---
:::::

#title
[AI-Ready]{.text-primary} with native MCP

#description
Built-in Model Context Protocol server connects your documentation to AI tools like Cursor, VS Code, and Claude. Automatic generation of `llms.txt` and `llms-full.txt` files for seamless LLM integration.
::::
:::
::
Loading
Loading