Skip to content

Commit a9fed2f

Browse files
larbishlarbish
committed
docs(template): update docus and add i18n as draft
1 parent 6a028d1 commit a9fed2f

File tree

2 files changed

+220
-36
lines changed

2 files changed

+220
-36
lines changed

‎docs/content/templates/docus-i18n.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
slug: docus-i18n
3+
subtitle: ""
4+
title: Docus I18n
5+
baseDir: .starters/i18n
6+
branch: main
7+
category: docs
8+
createdAt: 2023-11-15T17:41:03.087Z
9+
demo: https://docus.dev
10+
description: Write beautiful internationalized docs with Markdown and Nuxt I18n uesssh
11+
licenseType: nuxt-ui-pro
12+
mainScreen: /templates/docus.webp
13+
name: docus
14+
owner: nuxtlabs
15+
image1: /blog/docus.webp
16+
image2: ""
17+
image3: ""
18+
draft: true
19+
---
20+
21+
::template-core
22+
> A beautiful, internationalized starter for creating multi-language documentation with Docus
23+
24+
This is the i18n Docus starter template that provides everything you need to build beautiful, multi-language documentation sites with Markdown and Vue components.
25+
26+
## ✨ Features
27+
28+
- 🌍 **Internationalization** - Native i18n support for multi-language docs
29+
- 🎨 **Beautiful Design** - Clean, modern documentation theme
30+
- 📱 **Responsive** - Mobile-first responsive design
31+
- 🌙 **Dark Mode** - Built-in dark/light mode support
32+
- 🔍 **Search** - Full-text search functionality per language
33+
- 📝 **Markdown Enhanced** - Extended markdown with custom components
34+
- 🎨 **Customizable** - Easy theming and brand customization
35+
- ⚡ **Fast** - Optimized for performance with Nuxt 4
36+
- 🔧 **TypeScript** - Full TypeScript support
37+
38+
## 🚀 Quick Start
39+
40+
```bash
41+
# Install dependencies
42+
npm install
43+
44+
# Start development server
45+
npm run dev
46+
```
47+
48+
Your multilingual documentation site will be running at `http://localhost:3000`
49+
50+
## 🌍 Languages
51+
52+
This starter comes pre-configured with:
53+
- 🇺🇸 **English** (`en`) - Default language
54+
- 🇫🇷 **Français** (`fr`) - French translation
55+
56+
## 📁 Project Structure
57+
58+
```
59+
my-docs/
60+
├── content/ # Your markdown content
61+
│ ├── en/ # English content
62+
│ │ ├── index.md # English homepage
63+
│ │ └── docs/ # English documentation
64+
│ └── fr/ # French content
65+
│ ├── index.md # French homepage
66+
│ └── docs/ # French documentation
67+
├── public/ # Static assets
68+
├── nuxt.config.ts # Nuxt configuration with i18n setup
69+
└── package.json # Dependencies and scripts
70+
```
71+
72+
### Content Structure
73+
74+
The content is organized by language, making it easy to manage translations:
75+
76+
```
77+
content/
78+
├── en/ # English content
79+
│ ├── index.md
80+
│ ├── 1.getting-started/
81+
│ │ ├── installation.md
82+
│ │ └── configuration.md
83+
│ └── 2.essentials/
84+
│ ├── markdown.md
85+
│ └── components.md
86+
└── fr/ # French content
87+
├── index.md
88+
├── 1.getting-started/
89+
│ ├── installation.md
90+
│ └── configuration.md
91+
└── 2.essentials/
92+
├── markdown.md
93+
└── components.md
94+
```
95+
96+
## 🔗 URL Structure
97+
98+
The i18n starter generates URLs with language prefixes:
99+
100+
- English: `/en/getting-started/installation`
101+
- French: `/fr/getting-started/installation`
102+
- Default locale fallback: `/getting-started/installation` (redirects to English)
103+
104+
## ⚡ Built with
105+
106+
This starter comes pre-configured with:
107+
108+
- [Nuxt 4](https://nuxt.com) - The web framework
109+
- [Nuxt Content](https://content.nuxt.com/) - File-based CMS
110+
- [Nuxt i18n](https://i18n.nuxt.com/) - Internationalization
111+
- [Nuxt UI Pro](https://ui.nuxt.com/pro) - Premium UI components
112+
- [Nuxt Image](https://image.nuxt.com/) - Optimized images
113+
- [Tailwind CSS 4](https://tailwindcss.com/) - Utility-first CSS
114+
- [Docus Layer](https://www.npmjs.com/package/docus) - Documentation theme
115+
116+
## 📖 Documentation
117+
118+
For detailed documentation on customizing your Docus project, visit the [Docus Documentation](https://docus.dev)
119+
120+
## 🚀 Deployment
121+
122+
Build for production:
123+
124+
```bash
125+
npm run build
126+
```
127+
128+
The built files will be in the `.output` directory, ready for deployment to any hosting provider that supports Node.js.
129+
130+
## 📄 License
131+
132+
[MIT License](https://opensource.org/licenses/MIT)
133+
134+
#right
135+
:::template-features
136+
---
137+
features:
138+
- label: Nuxt 4
139+
content: The web framework
140+
- label: Nuxt I18n
141+
content: Internationalization support.
142+
- label: Nuxt UI Pro
143+
content: Offers a very large set of full customizable components.
144+
- label: TypeScript
145+
content: A fully typed development experience.
146+
- label: Nuxt Studio
147+
content: Supported by Nuxt Studio for fast updates and previews.
148+
- label: Search
149+
content: A full-text search modal empowered by Fuse.js.
150+
- label: Nuxt Image
151+
content: A powerful image component.
152+
- label: Nuxt Content
153+
content: A powerful content component.
154+
---
155+
:::
156+
::

‎docs/content/templates/docus.md

Lines changed: 64 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -18,45 +18,73 @@ image3: ""
1818
---
1919

2020
::template-core
21-
Docus is a theme based on the [UI Pro documentation template](https://docs-template.nuxt.dev/). While the visual style comes ready out of the box, your focus should be on writing content using the Markdown and [MDC syntax](https://content.nuxt.com/docs/files/markdown#mdc-syntax) provided by [Nuxt Content](https://content.nuxt.com).
22-
23-
We use this theme across all our Nuxt module documentations, including:
24-
25-
:::card-group
26-
::::card
27-
---
28-
icon: i-simple-icons-nuxtdotjs
29-
target: _blank
30-
title: Nuxt Image
31-
to: https://image.nuxt.com
32-
---
33-
The documentation of `@nuxt/image`
34-
::::
35-
36-
::::card
37-
---
38-
icon: i-simple-icons-nuxtdotjs
39-
target: _blank
40-
title: Nuxt Supabase
41-
to: https://supabase.nuxtjs.org
42-
---
43-
The documentation of `@nuxt/supabase`
44-
::::
45-
:::
21+
> A beautiful, minimal starter for creating documentation with Docus
22+
23+
This is the default Docus starter template that provides everything you need to build beautiful documentation sites with Markdown and Vue components.
24+
25+
## ✨ Features
26+
27+
- 🎨 **Beautiful Design** - Clean, modern documentation theme
28+
- 📱 **Responsive** - Mobile-first responsive design
29+
- 🌙 **Dark Mode** - Built-in dark/light mode support
30+
- 🔍 **Search** - Full-text search functionality
31+
- 📝 **Markdown Enhanced** - Extended markdown with custom components
32+
- 🎨 **Customizable** - Easy theming and brand customization
33+
- ⚡ **Fast** - Optimized for performance with Nuxt 4
34+
- 🔧 **TypeScript** - Full TypeScript support
35+
36+
## 🚀 Quick Start
37+
38+
```bash
39+
# Install dependencies
40+
npm install
41+
42+
# Start development server
43+
npm run dev
44+
```
45+
46+
Your documentation site will be running at `http://localhost:3000`
47+
48+
## 📁 Project Structure
49+
50+
```
51+
my-docs/
52+
├── content/ # Your markdown content
53+
│ ├── index.md # Homepage
54+
│ ├── 1.getting-started/ # Getting started section
55+
│ └── 2.essentials/ # Essential documentation
56+
├── public/ # Static assets
57+
└── package.json # Dependencies and scripts
58+
```
59+
60+
## ⚡ Built with
61+
62+
This starter comes pre-configured with:
63+
64+
- [Nuxt 4](https://nuxt.com) - The web framework
65+
- [Nuxt Content](https://content.nuxt.com/) - File-based CMS
66+
- [Nuxt UI Pro](https://ui.nuxt.com/pro) - Premium UI components
67+
- [Nuxt Image](https://image.nuxt.com/) - Optimized images
68+
- [Tailwind CSS 4](https://tailwindcss.com/) - Utility-first CSS
69+
- [Docus Layer](https://www.npmjs.com/package/docus) - Documentation theme
70+
71+
## 📖 Documentation
72+
73+
For detailed documentation on customizing your Docus project, visit the [Docus Documentation](https://docus.dev)
74+
75+
## 🚀 Deployment
76+
77+
Build for production:
78+
79+
```bash
80+
npm run build
81+
```
4682

47-
## Key Features
83+
The built files will be in the `.output` directory, ready for deployment to any hosting provider that supports Node.js.
4884

49-
This theme includes a range of features designed to improve documentation management:
85+
## 📄 License
5086

51-
- **Powered by** [**Nuxt 3**](https://nuxt.com): Utilizes the latest Nuxt framework for optimal performance.
52-
- **Built with** [**Nuxt UI**](https://ui.nuxt.com) **and** [**Nuxt UI Pro**](https://ui.nuxt.com/pro): Integrates a comprehensive suite of UI components.
53-
- [**MDC Syntax**](https://content.nuxt.com/usage/markdown) **via** [**Nuxt Content**](https://content.nuxt.com): Supports Markdown with component integration for dynamic content.
54-
- [**Nuxt Studio**](https://content.nuxt.com/docs/studio) **Compatible**: Write and edit your content visually. No Markdown knowledge is required!
55-
- **Auto-generated Sidebar Navigation**: Automatically generates navigation from content structure.
56-
- **Full-Text Search**: Includes built-in search functionality for content discovery.
57-
- **Optimized Typography**: Features refined typography for enhanced readability.
58-
- **Dark Mode**: Offers dark mode support for user preference.
59-
- **Extensive Functionality**: Explore the theme to fully appreciate its capabilities.
87+
[MIT License](https://opensource.org/licenses/MIT)
6088

6189
#right
6290
:::template-features

0 commit comments

Comments
 (0)