Skip to content

πŸ“š Multilingual technical documentation with Nuxt.js, Docus, and Nuxt Content. Guides on Python, JavaScript/TypeScript, DevOps, and AI. Deployed with GitHub Pages.

Notifications You must be signed in to change notification settings

KevinDeBenedetti/documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Docus i18n Starter

A beautiful, internationalized starter for creating multi-language documentation with Docus

This is the i18n Docus starter template that provides everything you need to build beautiful, multi-language documentation sites with Markdown and Vue components.

✨ Features

  • 🌍 Internationalization - Native i18n support for multi-language docs
  • 🎨 Beautiful Design - Clean, modern documentation theme
  • πŸ“± Responsive - Mobile-first responsive design
  • πŸŒ™ Dark Mode - Built-in dark/light mode support
  • πŸ” Search - Full-text search functionality per language
  • πŸ“ Markdown Enhanced - Extended markdown with custom components
  • 🎨 Customizable - Easy theming and brand customization
  • ⚑ Fast - Optimized for performance with Nuxt 4
  • πŸ”§ TypeScript - Full TypeScript support

πŸš€ Quick Start

# Install dependencies
npm install

# Start development server
npm run dev

Your multilingual documentation site will be running at http://localhost:3000

🌍 Languages

This starter comes pre-configured with:

  • πŸ‡ΊπŸ‡Έ English (en) - Default language
  • πŸ‡«πŸ‡· FranΓ§ais (fr) - French translation

πŸ“ Project Structure

my-docs/
β”œβ”€β”€ content/              # Your markdown content
β”‚   β”œβ”€β”€ en/              # English content
β”‚   β”‚   β”œβ”€β”€ index.md     # English homepage
β”‚   β”‚   └── docs/        # English documentation
β”‚   └── fr/              # French content
β”‚       β”œβ”€β”€ index.md     # French homepage
β”‚       └── docs/        # French documentation
β”œβ”€β”€ public/              # Static assets
β”œβ”€β”€ nuxt.config.ts       # Nuxt configuration with i18n setup
└── package.json         # Dependencies and scripts

Content Structure

The content is organized by language, making it easy to manage translations:

content/
β”œβ”€β”€ en/                   # English content
β”‚   β”œβ”€β”€ index.md
β”‚   β”œβ”€β”€ 1.getting-started/
β”‚   β”‚   β”œβ”€β”€ installation.md
β”‚   β”‚   └── configuration.md
β”‚   └── 2.essentials/
β”‚       β”œβ”€β”€ markdown.md
β”‚       └── components.md
└── fr/                   # French content
    β”œβ”€β”€ index.md
    β”œβ”€β”€ 1.getting-started/
    β”‚   β”œβ”€β”€ installation.md
    β”‚   └── configuration.md
    └── 2.essentials/
        β”œβ”€β”€ markdown.md
        └── components.md

πŸ”— URL Structure

The i18n starter generates URLs with language prefixes:

  • English: /en/getting-started/installation
  • French: /fr/getting-started/installation
  • Default locale fallback: /getting-started/installation (redirects to English)

⚑ Built with

This starter comes pre-configured with:

πŸ“– Documentation

For detailed documentation on customizing your Docus project, visit the Docus Documentation

πŸš€ Deployment

Build for production:

npm run build

The built files will be in the .output directory, ready for deployment to any hosting provider that supports Node.js.

πŸ“„ License

MIT License

About

πŸ“š Multilingual technical documentation with Nuxt.js, Docus, and Nuxt Content. Guides on Python, JavaScript/TypeScript, DevOps, and AI. Deployed with GitHub Pages.

Topics

Resources

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •