Skip to content

Commit e387adb

Browse files
tensor-ninjatensor-ninja
committed
initial
0 parents  commit e387adb

File tree

14 files changed

+3841
-0
lines changed

14 files changed

+3841
-0
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Setup Bun
26+
uses: oven-sh/setup-bun@v2
27+
with:
28+
bun-version: latest
29+
30+
- name: Setup Pages
31+
uses: actions/configure-pages@v5
32+
33+
- name: Install dependencies
34+
run: bun install
35+
36+
- name: Static HTML export with Nuxt
37+
run: bun run generate
38+
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: ./.output/public
43+
44+
deploy:
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
runs-on: ubuntu-latest
49+
needs: build
50+
steps:
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Nuxt dev/build outputs
2+
.output
3+
.data
4+
.nuxt
5+
.nitro
6+
.cache
7+
dist
8+
9+
# Node dependencies
10+
node_modules
11+
12+
# Logs
13+
logs
14+
*.log
15+
16+
# Misc
17+
.DS_Store
18+
.fleet
19+
.idea
20+
.eslintcache
21+
22+
# Local env files
23+
.env
24+
.env.*
25+
!.env.example
26+
27+
# npm pack
28+
*.tgz
29+
30+
# Temp files
31+
.tmp
32+
.profile
33+
*.0x
34+
35+
#VSC
36+
.history
37+
.wrangler

‎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)