From e32fe6ccf3d5dabfae05af7c4340ab300c3f9050 Mon Sep 17 00:00:00 2001 From: Djeex Date: Mon, 31 Aug 2026 19:22:38 +0200 Subject: [PATCH] Rewrite the README with real setup instructions --- README.md | 152 ++++++++++++++++++------------------------------------ 1 file changed, 49 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index aeca76a..679c43e 100644 --- a/README.md +++ b/README.md @@ -1,123 +1,69 @@ -# Docus i18n Starter +

+ -> A beautiful, internationalized starter for creating multi-language documentation with Docus +[![docu.djeex.fr](https://img.shields.io/badge/DocuΒ·djeex-00b0f0?style=for-the-badge&logoColor=white&logo=materialformkdocs)](https://docu.djeex.fr/) +[![Uptime-Kuma](https://stats.djeex.fr/api/badge/23/status?style=for-the-badge)](https://docu.djeex.fr/) +

-This is the i18n Docus starter template that provides everything you need to build beautiful, multi-language documentation sites with Markdown and Vue components. +# πŸ”§ Docs, more docs -## ✨ Features +**DocuΒ·djeex** is first and foremost a personal project aimed at self-hosting as many everyday services as possible, without relying on proprietary platforms (Google, Apple, Netflix, etc.). +This documentation site is built using [Nuxt.js](https://nuxt.com/), on the [Docus](https://docus.dev) theme (Nuxt UI + Nuxt Content). -- 🌍 **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 +This repository contains everything you need to edit pages, apply your changes, and redeploy the site. See [CUSTOMIZATIONS.md](CUSTOMIZATIONS.md) for everything added on top of the base Docus theme. -## πŸš€ Quick Start +## Requirements + +- Node.js 20 or later +- npm + +## Getting started + +Install dependencies: ```bash -# Install dependencies npm install +``` -# Start development server +Start the dev server: + +```bash npm run dev ``` -Your multilingual documentation site will be running at `http://localhost:3000` +The site will be available 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: - -- [Nuxt 4](https://nuxt.com) - The web framework -- [Nuxt Content](https://content.nuxt.com/) - File-based CMS -- [Nuxt i18n](https://i18n.nuxt.com/) - Internationalization -- [Nuxt UI](https://ui.nuxt.com) - UI components -- [Nuxt Image](https://image.nuxt.com/) - Optimized images -- [Tailwind CSS 4](https://tailwindcss.com/) - Utility-first CSS -- [Docus Layer](https://www.npmjs.com/package/docus) - Documentation theme - -## πŸ“– Documentation - -For detailed documentation on customizing your Docus project, visit the [Docus Documentation](https://docus.dev) - -### πŸ€– AI Assistant Skill - -Get started quickly with Docus by adding specialized knowledge to your AI assistant (Cursor, Claude, etc.): - -```bash -npx skills add nuxt-content/docus -``` - -This skill helps you create documentation faster by providing your AI assistant with best practices, MDC component usage, ready-to-use templates, writing guidelines, and configuration tips for Docus. Perfect for quickly scaffolding new documentation projects. - -## πŸš€ Deployment - -Build for production: +## Build ```bash npm run build ``` -The built files will be in the `.output` directory, ready for deployment to any hosting provider that supports Node.js. +This builds the production site (pointed at `https://docu.djeex.fr` via `NUXT_SITE_URL`) into `.output`. Run it with: -## πŸ“„ License +```bash +node .output/server/index.mjs +``` -[MIT License](https://opensource.org/licenses/MIT) \ No newline at end of file +## Project structure + +``` +content/ +β”œβ”€β”€ en/ # English content, served at /en/... +└── fr/ # French content, served at /fr/... + +app/ +β”œβ”€β”€ components/ # Custom components and overrides of Docus's own components +└── pages/ # The catch-all docs page + +content.config.ts # Content collections and frontmatter schema +nuxt.config.ts # Nuxt/Docus/i18n configuration +app/app.config.ts # Theme, colors, branding +``` + +## Languages + +- English (`en`) β€” default locale, served under `/en` +- French (`fr`) β€” served under `/fr` + +Visiting `/` redirects to `/en` or `/fr` based on the visitor's browser language (or a previous choice, remembered via cookie).