Skip to content

Commit dd38ab6

Browse files
larbishlarbish
committed
docs(starters): add readme
1 parent 900d1e1 commit dd38ab6

File tree

2 files changed

+182
-0
lines changed

2 files changed

+182
-0
lines changed

‎.starters/default/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Docus Default Starter
2+
3+
> A beautiful, minimal starter for creating documentation with Docus
4+
5+
This is the default Docus starter template that provides everything you need to build beautiful documentation sites with Markdown and Vue components.
6+
7+
## ✨ Features
8+
9+
- 🎨 **Beautiful Design** - Clean, modern documentation theme
10+
- 📱 **Responsive** - Mobile-first responsive design
11+
- 🌙 **Dark Mode** - Built-in dark/light mode support
12+
- 🔍 **Search** - Full-text search functionality
13+
- 📝 **Markdown Enhanced** - Extended markdown with custom components
14+
- 🎨 **Customizable** - Easy theming and brand customization
15+
- ⚡ **Fast** - Optimized for performance with Nuxt 4
16+
- 🔧 **TypeScript** - Full TypeScript support
17+
18+
## 🚀 Quick Start
19+
20+
```bash
21+
# Install dependencies
22+
npm install
23+
24+
# Start development server
25+
npm run dev
26+
```
27+
28+
Your documentation site will be running at `http://localhost:3000`
29+
30+
## 📁 Project Structure
31+
32+
```
33+
my-docs/
34+
├── content/ # Your markdown content
35+
│ ├── index.md # Homepage
36+
│ ├── 1.getting-started/ # Getting started section
37+
│ └── 2.essentials/ # Essential documentation
38+
├── public/ # Static assets
39+
└── package.json # Dependencies and scripts
40+
```
41+
42+
## ⚡ Built with
43+
44+
This starter comes pre-configured with:
45+
46+
- [Nuxt 4](https://nuxt.com) - The web framework
47+
- [Nuxt Content](https://content.nuxt.com/) - File-based CMS
48+
- [Nuxt UI Pro](https://ui.nuxt.com/pro) - Premium UI components
49+
- [Nuxt Image](https://image.nuxt.com/) - Optimized images
50+
- [Tailwind CSS 4](https://tailwindcss.com/) - Utility-first CSS
51+
- [Docus Layer](https://www.npmjs.com/package/docus) - Documentation theme
52+
53+
## 📖 Documentation
54+
55+
For detailed documentation on customizing your Docus project, visit the [Docus Documentation](https://docus.dev)
56+
57+
## 🚀 Deployment
58+
59+
Build for production:
60+
61+
```bash
62+
npm run build
63+
```
64+
65+
The built files will be in the `.output` directory, ready for deployment to any hosting provider that supports Node.js.
66+
67+
## 📄 License
68+
69+
[MIT License](https://opensource.org/licenses/MIT)

‎.starters/i18n/README.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# Docus i18n Starter
2+
3+
> A beautiful, internationalized starter for creating multi-language documentation with Docus
4+
5+
This is the i18n Docus starter template that provides everything you need to build beautiful, multi-language documentation sites with Markdown and Vue components.
6+
7+
## ✨ Features
8+
9+
- 🌍 **Internationalization** - Native i18n support for multi-language docs
10+
- 🎨 **Beautiful Design** - Clean, modern documentation theme
11+
- 📱 **Responsive** - Mobile-first responsive design
12+
- 🌙 **Dark Mode** - Built-in dark/light mode support
13+
- 🔍 **Search** - Full-text search functionality per language
14+
- 📝 **Markdown Enhanced** - Extended markdown with custom components
15+
- 🎨 **Customizable** - Easy theming and brand customization
16+
- ⚡ **Fast** - Optimized for performance with Nuxt 4
17+
- 🔧 **TypeScript** - Full TypeScript support
18+
19+
## 🚀 Quick Start
20+
21+
```bash
22+
# Install dependencies
23+
npm install
24+
25+
# Start development server
26+
npm run dev
27+
```
28+
29+
Your multilingual documentation site will be running at `http://localhost:3000`
30+
31+
## 🌍 Languages
32+
33+
This starter comes pre-configured with:
34+
- 🇺🇸 **English** (`en`) - Default language
35+
- 🇫🇷 **Français** (`fr`) - French translation
36+
37+
## 📁 Project Structure
38+
39+
```
40+
my-docs/
41+
├── content/ # Your markdown content
42+
│ ├── en/ # English content
43+
│ │ ├── index.md # English homepage
44+
│ │ └── docs/ # English documentation
45+
│ └── fr/ # French content
46+
│ ├── index.md # French homepage
47+
│ └── docs/ # French documentation
48+
├── public/ # Static assets
49+
├── nuxt.config.ts # Nuxt configuration with i18n setup
50+
└── package.json # Dependencies and scripts
51+
```
52+
53+
### Content Structure
54+
55+
The content is organized by language, making it easy to manage translations:
56+
57+
```
58+
content/
59+
├── en/ # English content
60+
│ ├── index.md
61+
│ ├── 1.getting-started/
62+
│ │ ├── installation.md
63+
│ │ └── configuration.md
64+
│ └── 2.essentials/
65+
│ ├── markdown.md
66+
│ └── components.md
67+
└── fr/ # French content
68+
├── index.md
69+
├── 1.getting-started/
70+
│ ├── installation.md
71+
│ └── configuration.md
72+
└── 2.essentials/
73+
├── markdown.md
74+
└── components.md
75+
```
76+
77+
## 🔗 URL Structure
78+
79+
The i18n starter generates URLs with language prefixes:
80+
81+
- English: `/en/getting-started/installation`
82+
- French: `/fr/getting-started/installation`
83+
- Default locale fallback: `/getting-started/installation` (redirects to English)
84+
85+
## ⚡ Built with
86+
87+
This starter comes pre-configured with:
88+
89+
- [Nuxt 4](https://nuxt.com) - The web framework
90+
- [Nuxt Content](https://content.nuxt.com/) - File-based CMS
91+
- [Nuxt i18n](https://i18n.nuxt.com/) - Internationalization
92+
- [Nuxt UI Pro](https://ui.nuxt.com/pro) - Premium UI components
93+
- [Nuxt Image](https://image.nuxt.com/) - Optimized images
94+
- [Tailwind CSS 4](https://tailwindcss.com/) - Utility-first CSS
95+
- [Docus Layer](https://www.npmjs.com/package/docus) - Documentation theme
96+
97+
## 📖 Documentation
98+
99+
For detailed documentation on customizing your Docus project, visit the [Docus Documentation](https://docus.dev)
100+
101+
## 🚀 Deployment
102+
103+
Build for production:
104+
105+
```bash
106+
npm run build
107+
```
108+
109+
The built files will be in the `.output` directory, ready for deployment to any hosting provider that supports Node.js.
110+
111+
## 📄 License
112+
113+
[MIT License](https://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)