diff --git a/README.md b/README.md index 81aec113c..a2d4bf97c 100644 --- a/README.md +++ b/README.md @@ -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: @@ -31,7 +34,7 @@ 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 @@ -39,6 +42,8 @@ The CLI scaffolds a complete documentation project with: - 🎹 **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). diff --git a/docs/content/en/index.md b/docs/content/en/index.md index d00aec72b..eb7ee8fb4 100644 --- a/docs/content/en/index.md +++ b/docs/content/en/index.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 `` . :::: + + ::::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. + :::: ::: :: diff --git a/docs/content/fr/index.md b/docs/content/fr/index.md index de4a07edc..8699b027a 100644 --- a/docs/content/fr/index.md +++ b/docs/content/fr/index.md @@ -57,14 +57,14 @@ Publiez instantanĂ©ment une documentation Ă©lĂ©gante, optimisĂ©e pour le SEO, av --- :::::floating-nuxt ::::: - + #title - Construit avec [Nuxt 4]{.text-primary} - + Construit avec [Nuxt]{.text-primary} + #description OptimisĂ© par votre meta framework Vue prĂ©fĂ©rĂ©. Docus vous donne tout ce dont vous avez besoin pour crĂ©er des sites rapides, performants et optimisĂ©s pour le SEO. :::: - + ::::u-page-card --- spotlight: true @@ -82,14 +82,14 @@ Publiez instantanĂ©ment une documentation Ă©lĂ©gante, optimisĂ©e pour le SEO, av light: /landing/light/templates-ui-pro.webp --- ::::: - + #title PropulsĂ© par [Nuxt UI]{.text-primary} - + #description Sexy, minimaliste et personnalisable. Docus intĂšgre Nuxt UI pour vous offrir la meilleure expĂ©rience pour Ă©crire une documentation sans boilerplate, concentrez-vous simplement sur votre contenu. :::: - + ::::u-page-card --- spotlight: true @@ -102,21 +102,21 @@ Publiez instantanĂ©ment une documentation Ă©lĂ©gante, optimisĂ©e pour le SEO, av ::::::::note{.my-0} Voici des informations supplĂ©mentaires pour vous. :::::::: - + ::::::::tip{.my-0} Voici une suggestion utile. :::::::: - + ::::::::warning{.my-0} Faites attention Ă  cette action car elle pourrait avoir des rĂ©sultats inattendus. :::::::: - + ::::::::caution{.my-0} Cette action est irrĂ©versible. :::::::: ::::::: :::::: - + ::::::tabs-item --- class: mt-5 mb-2 text-xs overflow-x-auto @@ -127,29 +127,29 @@ Publiez instantanĂ©ment une documentation Ă©lĂ©gante, optimisĂ©e pour le SEO, av ::note Voici des informations supplĂ©mentaires. :: - + ::tip Voici une suggestion utile. :: - + ::warning Faites attention Ă  cette action car elle pourrait avoir des rĂ©sultats inattendus. :: - + ::caution Cette action est irrĂ©versible. :: ``` :::::: ::::: - + #title Markdown amĂ©liorĂ© par [Nuxt Content]{.text-primary} - + #description La seule chose dont vous devez vous soucier est d'Ă©crire votre contenu. RĂ©digez vos pages en Markdown et intĂ©grer des composants Nuxt UI ou des composants Vue personnalisĂ©s. La structure, le routing et le rendu sont gĂ©rĂ©s pour vous. :::: - + ::::u-page-card --- spotlight: true @@ -172,14 +172,14 @@ Publiez instantanĂ©ment une documentation Ă©lĂ©gante, optimisĂ©e pour le SEO, av }) ``` ::::: - + #title Personnalisation avec [Nuxt App Config]{.text-primary} - + #description Mettez Ă  jour les couleurs, les liens sociaux, les logos ou mĂȘme le style de vos composants globalement via le `app.config.ts`, sans modification directe du code. :::: - + ::::u-page-card --- spotlight: true @@ -188,14 +188,14 @@ Publiez instantanĂ©ment une documentation Ă©lĂ©gante, optimisĂ©e pour le SEO, av --- :::::color-mode-switch ::::: - + #title [Nuxt Color]{.text-primary} - + #description Light et dark mode intĂ©grĂ©, aucune configuration nĂ©cessaire. :::: - + ::::u-page-card --- spotlight: true @@ -214,14 +214,14 @@ Publiez instantanĂ©ment une documentation Ă©lĂ©gante, optimisĂ©e pour le SEO, av loading: lazy --- ::::: - + #title Navigation intĂ©grĂ©e et [recherche textuelle]{.text-primary} - + #description Concentrez-vous uniquement sur votre contenu, Docus gĂ©nĂšre automatiquement une modale de recherche et la navigation latĂ©rale pour vous. :::: - + ::::u-page-card --- spotlight: true @@ -231,14 +231,14 @@ Publiez instantanĂ©ment une documentation Ă©lĂ©gante, optimisĂ©e pour le SEO, av :::::browser-frame :video{.rounded-md controls loop playsinline src="https://res.cloudinary.com/nuxt/video/upload/v1747230893/studio/wzt9zfmdvk7hgmdx3cnt.mp4"} ::::: - + #title Collaborez sur [Nuxt Studio]{.text-primary} - + #description RĂ©digez et gĂ©rez votre contenu visuellement, sans aucune connaissance de Markdown requise. Laissez vos collĂšgues non techniques collaborer sur la documentation et intĂ©grer des composants Vue sans compĂ©tences en code. :::: - + ::::u-page-card --- spotlight: true @@ -256,12 +256,62 @@ Publiez instantanĂ©ment une documentation Ă©lĂ©gante, optimisĂ©e pour le SEO, av --- :::::: ::::: - + #title Optimisation [Nuxt Image]{.text-primary} - + #description Docus convertit automatiquement les images Markdown pour utiliser ``. :::: + + ::::u-page-card + --- + spotlight: true + class: col-span-2 lg:col-span-1 + target: _blank + to: /fr/concepts/internationalization + --- + :::::u-color-mode-image + --- + height: 195 + width: 403 + alt: Illustration de l'internationalisation + class: w-full h-auto rounded-lg + dark: /landing/dark/i18n.svg + light: /landing/light/i18n.svg + --- + ::::: + + #title + Support d'[internationalisation]{.text-primary} + + #description + Support i18n intĂ©grĂ© avec routage automatique et gestion de contenu. CrĂ©ez une documentation multilingue sans effort. + :::: + + ::::u-page-card + --- + spotlight: true + class: col-span-2 + target: _blank + to: /fr/ai/mcp + --- + :::::u-color-mode-image + --- + height: 400 + width: 859 + alt: Illustration du serveur MCP natif et contenu prĂȘt pour l'IA + class: w-full h-auto rounded-lg + dark: /landing/dark/mcp.svg + light: /landing/light/mcp.svg + --- + ::::: + + #title + PrĂȘt pour l'[IA]{.text-primary} avec MCP natif + + #description + Serveur Model Context Protocol intĂ©grĂ© qui connecte votre documentation aux outils IA comme Cursor, VS Code et Claude. GĂ©nĂ©ration automatique des fichiers `llms.txt` et `llms-full.txt` pour une intĂ©gration LLM transparente. + :::: ::: :: diff --git a/docs/public/landing/dark/i18n.svg b/docs/public/landing/dark/i18n.svg new file mode 100644 index 000000000..36067b113 --- /dev/null +++ b/docs/public/landing/dark/i18n.svg @@ -0,0 +1,126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/public/landing/dark/mcp.svg b/docs/public/landing/dark/mcp.svg new file mode 100644 index 000000000..df456a1a8 --- /dev/null +++ b/docs/public/landing/dark/mcp.svg @@ -0,0 +1,113 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/public/landing/dark/nuxt-image.svg b/docs/public/landing/dark/nuxt-image.svg index 81cfa3f42..cedf1330f 100644 --- a/docs/public/landing/dark/nuxt-image.svg +++ b/docs/public/landing/dark/nuxt-image.svg @@ -1,83 +1,20 @@ - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + diff --git a/docs/public/landing/light/i18n.svg b/docs/public/landing/light/i18n.svg new file mode 100644 index 000000000..7c7efce47 --- /dev/null +++ b/docs/public/landing/light/i18n.svg @@ -0,0 +1,126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/public/landing/light/mcp.svg b/docs/public/landing/light/mcp.svg new file mode 100644 index 000000000..94d733c7d --- /dev/null +++ b/docs/public/landing/light/mcp.svg @@ -0,0 +1,115 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/public/landing/light/nuxt-image.svg b/docs/public/landing/light/nuxt-image.svg index 960628d6e..52acfeab2 100644 --- a/docs/public/landing/light/nuxt-image.svg +++ b/docs/public/landing/light/nuxt-image.svg @@ -1,83 +1,20 @@ - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + diff --git a/layer/app/components/docs/DocsPageHeaderLinks.vue b/layer/app/components/docs/DocsPageHeaderLinks.vue index 7800b407b..a0220cd14 100644 --- a/layer/app/components/docs/DocsPageHeaderLinks.vue +++ b/layer/app/components/docs/DocsPageHeaderLinks.vue @@ -3,6 +3,7 @@ import { useClipboard } from '@vueuse/core' import { useRuntimeConfig } from '#imports' const route = useRoute() +const toast = useToast() const appBaseURL = useRuntimeConfig().app?.baseURL || '/' const { copy, copied } = useClipboard() @@ -10,7 +11,7 @@ const { t } = useDocusI18n() const markdownLink = computed(() => `${window?.location?.origin}${appBaseURL}raw${route.path}.md`) const items = [ - { + [{ label: t('docs.copy.link'), icon: 'i-lucide-link', onSelect() { @@ -34,7 +35,26 @@ const items = [ icon: 'i-simple-icons:anthropic', target: '_blank', to: `https://claude.ai/new?q=${encodeURIComponent(`Read ${markdownLink.value} so I can ask questions about it.`)}`, - }, + }], + [ + { + label: 'Copy MCP Server URL', + icon: 'i-lucide-link', + onSelect() { + copy(`${window?.location?.origin}${appBaseURL}mcp`) + toast.add({ + title: 'Copied to clipboard', + icon: 'i-lucide-check-circle', + }) + }, + }, + { + label: 'Add MCP Server', + icon: 'i-simple-icons:cursor', + target: '_blank', + to: `/mcp/deeplink`, + }, + ], ] async function copyPage() {