docus 4.0.0-beta.9 → 4.0.1

package/README.md

@@ -14,6 +14,7 @@ This is the official Nuxt layer for [Docus](https://docus.dev), providing a comp
 - ✨ **Beautiful Design** - Clean, modern documentation theme
 - 📱 **Responsive** - Mobile-first responsive design
 - 🌙 **Dark Mode** - Built-in dark/light mode support
+- 🌍 **Internationalization** - Native i18n support with automatic routing and language switching
 - 🔍 **Search** - Full-text search functionality
 - 📝 **Markdown Enhanced** - Extended markdown with custom components
 - 🎨 **Customizable** - Easy theming and customization
@@ -35,7 +36,7 @@ The easiest way to get started is using the Docus CLI, which automatically sets
 
 ```bash
 # Create a new documentation project
-npx create docus my-docs
+npx create-docus my-docs
 
 # Navigate to your project
 cd my-docs
@@ -46,6 +47,13 @@ npm run dev
 
 This creates a complete documentation project pre-configured with `docus`.
 
+For multi-language documentation, use the i18n template:
+
+```bash
+# Create a new i18n documentation project
+npx create-docus my-docs -t i18n
+```
+
 ### Option 2: Manual Setup
 
 #### Option 2a: Nuxt Config (recommended)
@@ -58,6 +66,21 @@ export default defineNuxtConfig({
 })
 ```
 
+For internationalization, also add the `@nuxtjs/i18n` module:
+
+```typescript
+export default defineNuxtConfig({
+  modules: ['@nuxtjs/i18n'],
+  i18n: {
+    defaultLocale: 'en',
+    locales: [
+      { code: 'en', name: 'English' },
+      { code: 'fr', name: 'Français' },
+    ],
+  }
+})
+```
+
 #### Option 2b: CLI Usage 
 
 Use directly with Nuxt CLI:

package/app/components/app/AppHeader.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { useDocusI18n } from '~/composables/useDocusI18n'
+import { useDocusI18n } from '../../composables/useDocusI18n'
 
 const appConfig = useAppConfig()
 const site = useSiteConfig()

package/app/components/docs/DocsPageHeaderLinks.vue

@@ -7,7 +7,6 @@ const { copy, copied } = useClipboard()
 const { t } = useDocusI18n()
 
 const markdownLink = computed(() => `${window?.location?.origin}/raw${route.path}.md`)
-
 const items = [
   {
     label: 'Copy Markdown link',
@@ -41,6 +40,11 @@ const items = [
     to: `https://claude.ai/new?q=${encodeURIComponent(`Read ${markdownLink.value} so I can ask questions about it.`)}`,
   },
 ]
+
+async function copyPage() {
+  const page = await $fetch<string>(`/raw${route.path}.md`)
+  copy(page)
+}
 </script>
 
 <template>
@@ -53,7 +57,7 @@ const items = [
       :ui="{
         leadingIcon: [copied ? 'text-primary' : 'text-neutral', 'size-3.5'],
       }"
-      @click="copy(markdownLink)"
+      @click="copyPage"
     />
 
     <UDropdownMenu

package/app/pages/[[lang]]/[...slug].vue

@@ -2,7 +2,7 @@
 import { kebabCase } from 'scule'
 import type { ContentNavigationItem, Collections, DocsCollectionItem } from '@nuxt/content'
 import { findPageHeadline } from '@nuxt/content/utils'
-import { addPrerenderPath } from '~/utils/prerender'
+import { addPrerenderPath } from '../../utils/prerender'
 
 definePageMeta({
   layout: 'docs',

package/i18n/i18n.config.ts

@@ -0,0 +1,15 @@
+export default defineI18nConfig(async () => {
+  const config = useRuntimeConfig().public
+
+  const messages: Record<string, Record<string, never>> = {}
+  await Promise.all(
+    config.i18n.locales.map(async (locale) => {
+      const localeFile = await import(`./locales/${locale.code}.json`)
+      messages[locale.code] = localeFile.default
+    }),
+  )
+
+  return {
+    messages,
+  }
+})

package/i18n/locales/en.json

@@ -0,0 +1,18 @@
+{
+  "common": {
+    "or": "or"
+  },
+  "docs": {
+    "copy": {
+      "page": "Copy page",
+      "link": "Copy Markdown page",
+      "view": "View as Markdown",
+      "gpt": "Open in ChatGPT",
+      "claude": "Open in Claude"
+    },
+    "links": "Community",
+    "toc": "On this page",
+    "report": "Report an issue",
+    "edit": "Edit this page"
+  }
+}

package/i18n/locales/fr.json

@@ -0,0 +1,18 @@
+{
+  "common": {
+    "or": "ou"
+  },
+  "docs": {
+    "copy": {
+      "page": "Copier la page",
+      "link": "Copier la page Markdown",
+      "view": "Voir en Markdown",
+      "gpt": "Ouvrir dans ChatGPT",
+      "claude": "Ouvrir dans Claude"
+    },
+    "links": "Communauté",
+    "toc": "Sur cette page",
+    "report": "Signaler un problème",
+    "edit": "Éditer cette page"
+  }
+} 

package/nuxt.config.ts

@@ -4,6 +4,7 @@ const { resolve } = createResolver(import.meta.url)
 
 export default defineNuxtConfig({
   modules: [
+    resolve('./modules/default-configs'),
     '@nuxt/ui-pro',
     '@nuxt/content',
     '@nuxt/image',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docus",
   "description": "Nuxt layer for Docus documentation theme",
-  "version": "4.0.0-beta.9",
+  "version": "4.0.1",
   "type": "module",
   "main": "./nuxt.config.ts",
   "repository": {
@@ -12,6 +12,7 @@
   "license": "MIT",
   "files": [
     "app",
+    "i18n",
     "content.config.ts",
     "modules",
     "nuxt.config.ts",
@@ -27,14 +28,15 @@
     "@nuxt/content": "^3.6.3",
     "@nuxt/image": "^1.10.0",
     "@nuxt/kit": "^4.0.1",
-    "@nuxt/ui-pro": "^3.2.0",
+    "@nuxt/ui-pro": "^3.3.0",
+    "@nuxtjs/i18n": "^10.0.3",
     "@nuxtjs/mdc": "^0.17.2",
     "@nuxtjs/robots": "^5.4.0",
     "@vueuse/core": "^13.5.0",
     "defu": "^6.1.4",
     "git-url-parse": "^16.1.0",
     "minimark": "^0.2.0",
-    "motion-v": "^1.6.0",
+    "motion-v": "^1.6.1",
     "nuxt-llms": "^0.1.3",
     "nuxt-og-image": "^5.1.9",
     "pkg-types": "^2.2.0",
@@ -43,9 +45,6 @@
     "ufo": "^1.6.1",
     "unist-util-visit": "^5.0.0"
   },
-  "devDependencies": {
-    "@nuxtjs/i18n": "^9.5.6"
-  },
   "peerDependencies": {
     "better-sqlite3": "12.x",
     "nuxt": "4.x"

package/server/routes/raw/[...slug].md.get.ts

@@ -1,6 +1,7 @@
 import { withLeadingSlash } from 'ufo'
 import { stringify } from 'minimark/stringify'
 import { queryCollection } from '@nuxt/content/nitro'
+import type { Collections } from '@nuxt/content'
 
 export default eventHandler(async (event) => {
   const slug = getRouterParams(event)['slug.md']
@@ -9,7 +10,26 @@ export default eventHandler(async (event) => {
   }
 
   const path = withLeadingSlash(slug.replace('.md', ''))
-  const page = await queryCollection(event, 'docs').path(path).first()
+  const config = useRuntimeConfig(event).public
+
+  let collectionName = 'docs'
+  if (config.i18n?.locales) {
+    const pathSegments = path.split('/').filter(Boolean)
+    const firstSegment = pathSegments[0]
+
+    const availableLocales = config.i18n.locales.map((locale: string | { code: string }) =>
+      typeof locale === 'string' ? locale : locale.code,
+    )
+
+    if (firstSegment && availableLocales.includes(firstSegment)) {
+      collectionName = `docs_${firstSegment}`
+    }
+    else if (config.i18n.defaultLocale) {
+      collectionName = `docs_${config.i18n.defaultLocale}`
+    }
+  }
+
+  const page = await queryCollection(event, collectionName as keyof Collections).path(path).first()
   if (!page) {
     throw createError({ statusCode: 404, statusMessage: 'Page not found', fatal: true })
   }

package/utils/git.ts

@@ -23,7 +23,7 @@ export function getGitBranch() {
     return envName
   }
   try {
-    const branch = execSync('git rev-parse --abbrev-ref HEAD').toString().trim()
+    const branch = execSync('git rev-parse --abbrev-ref HEAD', { stdio: ['ignore', 'pipe', 'ignore'] }).toString().trim()
     if (branch && branch !== 'HEAD') {
       return branch
     }