create-bunspace 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bin.js +137 -6
- package/dist/templates/fumadocs/.env.example +49 -0
- package/dist/templates/fumadocs/.github/workflows/deploy.yml +89 -0
- package/dist/templates/fumadocs/CLAUDE.md +164 -0
- package/dist/templates/fumadocs/LICENSE +21 -0
- package/dist/templates/fumadocs/MUST-FOLLOW-GUIDELINES.md +269 -0
- package/dist/templates/fumadocs/README.md +319 -0
- package/dist/templates/fumadocs/biome.json +41 -0
- package/dist/templates/fumadocs/bun.lock +883 -0
- package/dist/templates/fumadocs/content-template/docs/getting-started/index.mdx +92 -0
- package/dist/templates/fumadocs/content-template/docs/getting-started/installation.mdx +168 -0
- package/dist/templates/fumadocs/content-template/docs/getting-started/quick-start.mdx +168 -0
- package/dist/templates/fumadocs/content-template/docs/index.mdx +70 -0
- package/dist/templates/fumadocs/content-template/en/docs/getting-started/index.mdx +92 -0
- package/dist/templates/fumadocs/content-template/en/docs/getting-started/installation.mdx +168 -0
- package/dist/templates/fumadocs/content-template/en/docs/getting-started/quick-start.mdx +168 -0
- package/dist/templates/fumadocs/content-template/en/docs/index.mdx +69 -0
- package/dist/templates/fumadocs/messages/en.json +14 -0
- package/dist/templates/fumadocs/messages/es.json +14 -0
- package/dist/templates/fumadocs/next.config.mjs +35 -0
- package/dist/templates/fumadocs/oxlint.json +14 -0
- package/dist/templates/fumadocs/package.json +35 -0
- package/dist/templates/fumadocs/postcss.config.mjs +5 -0
- package/dist/templates/fumadocs/source.config.ts +31 -0
- package/dist/templates/fumadocs/src/app/(home)/layout.tsx +6 -0
- package/dist/templates/fumadocs/src/app/(home)/page.tsx +132 -0
- package/dist/templates/fumadocs/src/app/api/search/route.ts +9 -0
- package/dist/templates/fumadocs/src/app/docs/[[...slug]]/page.tsx +62 -0
- package/dist/templates/fumadocs/src/app/docs/layout.tsx +11 -0
- package/dist/templates/fumadocs/src/app/en/docs/[[...slug]]/page.tsx +61 -0
- package/dist/templates/fumadocs/src/app/en/docs/layout.tsx +11 -0
- package/dist/templates/fumadocs/src/app/global.css +3 -0
- package/dist/templates/fumadocs/src/app/layout.tsx +47 -0
- package/dist/templates/fumadocs/src/app/llms-full.txt/route.ts +10 -0
- package/dist/templates/fumadocs/src/app/og/docs/[...slug]/route.tsx +27 -0
- package/dist/templates/fumadocs/src/components/language-selector.tsx +56 -0
- package/dist/templates/fumadocs/src/components/markdown-actions.tsx +61 -0
- package/dist/templates/fumadocs/src/config/site.config.ts +115 -0
- package/dist/templates/fumadocs/src/lib/layout.shared.tsx +23 -0
- package/dist/templates/fumadocs/src/lib/source.ts +91 -0
- package/dist/templates/fumadocs/src/mdx-components.tsx +14 -0
- package/dist/templates/fumadocs/tsconfig.json +46 -0
- package/package.json +1 -1
- package/templates/fumadocs/.env.example +49 -0
- package/templates/fumadocs/.github/workflows/deploy.yml +89 -0
- package/templates/fumadocs/CLAUDE.md +164 -0
- package/templates/fumadocs/LICENSE +21 -0
- package/templates/fumadocs/MUST-FOLLOW-GUIDELINES.md +269 -0
- package/templates/fumadocs/README.md +319 -0
- package/templates/fumadocs/biome.json +41 -0
- package/templates/fumadocs/bun.lock +883 -0
- package/templates/fumadocs/content-template/docs/getting-started/index.mdx +92 -0
- package/templates/fumadocs/content-template/docs/getting-started/installation.mdx +168 -0
- package/templates/fumadocs/content-template/docs/getting-started/quick-start.mdx +168 -0
- package/templates/fumadocs/content-template/docs/index.mdx +70 -0
- package/templates/fumadocs/content-template/en/docs/getting-started/index.mdx +92 -0
- package/templates/fumadocs/content-template/en/docs/getting-started/installation.mdx +168 -0
- package/templates/fumadocs/content-template/en/docs/getting-started/quick-start.mdx +168 -0
- package/templates/fumadocs/content-template/en/docs/index.mdx +69 -0
- package/templates/fumadocs/messages/en.json +14 -0
- package/templates/fumadocs/messages/es.json +14 -0
- package/templates/fumadocs/next.config.mjs +35 -0
- package/templates/fumadocs/oxlint.json +14 -0
- package/templates/fumadocs/package.json +35 -0
- package/templates/fumadocs/postcss.config.mjs +5 -0
- package/templates/fumadocs/source.config.ts +31 -0
- package/templates/fumadocs/src/app/(home)/layout.tsx +6 -0
- package/templates/fumadocs/src/app/(home)/page.tsx +132 -0
- package/templates/fumadocs/src/app/api/search/route.ts +9 -0
- package/templates/fumadocs/src/app/docs/[[...slug]]/page.tsx +62 -0
- package/templates/fumadocs/src/app/docs/layout.tsx +11 -0
- package/templates/fumadocs/src/app/en/docs/[[...slug]]/page.tsx +61 -0
- package/templates/fumadocs/src/app/en/docs/layout.tsx +11 -0
- package/templates/fumadocs/src/app/global.css +3 -0
- package/templates/fumadocs/src/app/layout.tsx +47 -0
- package/templates/fumadocs/src/app/llms-full.txt/route.ts +10 -0
- package/templates/fumadocs/src/app/og/docs/[...slug]/route.tsx +27 -0
- package/templates/fumadocs/src/components/language-selector.tsx +56 -0
- package/templates/fumadocs/src/components/markdown-actions.tsx +61 -0
- package/templates/fumadocs/src/config/site.config.ts +115 -0
- package/templates/fumadocs/src/lib/layout.shared.tsx +23 -0
- package/templates/fumadocs/src/lib/source.ts +91 -0
- package/templates/fumadocs/src/mdx-components.tsx +14 -0
- package/templates/fumadocs/tsconfig.json +46 -0
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Introducción
|
|
3
|
+
description: 'Introducción a {{PROJECT_NAME}} - {{DESCRIPTION}}'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { Callout, Steps } from 'fumadocs-ui/components';
|
|
7
|
+
import { Terminal } from 'lucide-react';
|
|
8
|
+
|
|
9
|
+
# Introducción
|
|
10
|
+
|
|
11
|
+
Bienvenido a la documentación de **{{PROJECT_NAME}}**.
|
|
12
|
+
|
|
13
|
+
## ¿Qué es {{PROJECT_NAME}}?
|
|
14
|
+
|
|
15
|
+
<Callout type="info">
|
|
16
|
+
<p><strong>{{DESCRIPTION}}</strong></p>
|
|
17
|
+
</Callout>
|
|
18
|
+
|
|
19
|
+
Este template está diseñado para proporcionarte una base sólida para documentar tus proyectos usando Fumadocs.
|
|
20
|
+
|
|
21
|
+
## Requisitos Previos
|
|
22
|
+
|
|
23
|
+
Antes de comenzar, asegúrate de tener instalado:
|
|
24
|
+
|
|
25
|
+
- **Bun** v1.1.43 o superior
|
|
26
|
+
- **Node.js** v20 o superior (compatibilidad)
|
|
27
|
+
|
|
28
|
+
## Instalación Rápida
|
|
29
|
+
|
|
30
|
+
<Steps>
|
|
31
|
+
### 1. Clona o crea tu proyecto
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# Si usas mks-scaffolder
|
|
35
|
+
bunx mks-scaffolder create mi-proyecto --template fumadocs
|
|
36
|
+
|
|
37
|
+
# O si clonas directamente
|
|
38
|
+
git clone https://github.com/{{GITHUB_REPO}}.git
|
|
39
|
+
cd mi-proyecto
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### 2. Instala dependencias
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
bun install
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### 3. Configura las variables de entorno
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
cp .env.example .env.local
|
|
52
|
+
# Edita .env.local con tus valores
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 4. Inicia el servidor de desarrollo
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
bun run dev
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Abre [http://localhost:3000](http://localhost:3000) en tu navegador.
|
|
62
|
+
|
|
63
|
+
</Steps>
|
|
64
|
+
|
|
65
|
+
## Estructura del Proyecto
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
.
|
|
69
|
+
├── content/ # Tu documentación en MDX
|
|
70
|
+
│ ├── docs/ # Versión en español
|
|
71
|
+
│ └── en/docs/ # Versión en inglés
|
|
72
|
+
├── messages/ # Traducciones de la UI
|
|
73
|
+
│ ├── es.json
|
|
74
|
+
│ └── en.json
|
|
75
|
+
├── src/
|
|
76
|
+
│ ├── app/ # Páginas de Next.js
|
|
77
|
+
│ ├── components/ # Componentes React
|
|
78
|
+
│ ├── lib/ # Utilidades
|
|
79
|
+
│ └── config/ # Configuración del sitio
|
|
80
|
+
├── public/ # Archivos estáticos
|
|
81
|
+
└── .env.local # Variables de entorno (no en git)
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Próximos Pasos
|
|
85
|
+
|
|
86
|
+
- [Configuración](/docs/getting-started/installation) - Configura tu entorno
|
|
87
|
+
- [Quick Start](/docs/getting-started/quick-start) - Comienza rápidamente
|
|
88
|
+
- [Características](/docs/features) - Descubre lo que puedes hacer
|
|
89
|
+
|
|
90
|
+
<Callout type="tip">
|
|
91
|
+
Usa <code>content-template/</code> como referencia para crear tu propia estructura de documentación.
|
|
92
|
+
</Callout>
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Instalación
|
|
3
|
+
description: 'Instalación y configuración de {{PROJECT_NAME}}'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { Callout, Steps, Tabs, Tab } from 'fumadocs-ui/components';
|
|
7
|
+
import { Terminal, FileCode } from 'lucide-react';
|
|
8
|
+
|
|
9
|
+
# Instalación
|
|
10
|
+
|
|
11
|
+
Guía completa de instalación para {{PROJECT_NAME}}.
|
|
12
|
+
|
|
13
|
+
## Opciones de Instalación
|
|
14
|
+
|
|
15
|
+
<Tabs items={['Usando mks-scaffolder', 'Manual', 'GitHub Clone']}>
|
|
16
|
+
<Tab value="Usando mks-scaffolder">
|
|
17
|
+
<Steps>
|
|
18
|
+
### Crea un nuevo proyecto
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
bunx mks-scaffolder create mi-proyecto --template fumadocs
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Responde las preguntas interactivas:
|
|
25
|
+
- **Project name**: `mi-proyecto`
|
|
26
|
+
- **Description**: Descripción de tu proyecto
|
|
27
|
+
- **Author**: Tu nombre
|
|
28
|
+
- **Base path**: `/mi-proyecto` (para GitHub Pages)
|
|
29
|
+
|
|
30
|
+
### Entra al directorio
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
cd mi-proyecto
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Instala dependencias e inicia
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
bun install
|
|
40
|
+
bun run dev
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
</Steps>
|
|
44
|
+
</Tab>
|
|
45
|
+
|
|
46
|
+
<Tab value="Manual">
|
|
47
|
+
<Steps>
|
|
48
|
+
### Crea el proyecto
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
mkdir mi-proyecto && cd mi-proyecto
|
|
52
|
+
bun init -y
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Instala dependencias
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
bun add next fumadocs-ui fumadocs-mdx next-intl lucide-react
|
|
59
|
+
bun add -d @types/node @types/react @types/react-dom
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Copia los archivos del template
|
|
63
|
+
|
|
64
|
+
Copia el contenido de `mks-fumadocs-template/` a tu proyecto.
|
|
65
|
+
|
|
66
|
+
### Configura .env.local
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
PROJECT_NAME=Mi Proyecto
|
|
70
|
+
DESCRIPTION=Descripción
|
|
71
|
+
AUTHOR=Tu Nombre
|
|
72
|
+
BASE_PATH=/mi-proyecto
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
</Steps>
|
|
76
|
+
</Tab>
|
|
77
|
+
|
|
78
|
+
<Tab value="GitHub Clone">
|
|
79
|
+
<Steps>
|
|
80
|
+
### Clona el repositorio
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
git clone https://github.com/{{GITHUB_REPO}}.git mi-proyecto
|
|
84
|
+
cd mi-proyecto
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Instala dependencias
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
bun install
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Configura el proyecto
|
|
94
|
+
|
|
95
|
+
Edita `.env.local` con tus valores.
|
|
96
|
+
|
|
97
|
+
</Steps>
|
|
98
|
+
</Tab>
|
|
99
|
+
</Tabs>
|
|
100
|
+
|
|
101
|
+
## Verificación
|
|
102
|
+
|
|
103
|
+
<Callout type="success">
|
|
104
|
+
Para verificar que todo funciona correctamente, ejecuta:
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
bun run build
|
|
108
|
+
bun run start
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Deberías ver la documentación en <code>http://localhost:3000</code>
|
|
112
|
+
</Callout>
|
|
113
|
+
|
|
114
|
+
## Variables de Entorno
|
|
115
|
+
|
|
116
|
+
Crea un archivo `.env.local` en la raíz del proyecto:
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
# Información del proyecto
|
|
120
|
+
PROJECT_NAME=Mi Proyecto
|
|
121
|
+
DESCRIPTION=Descripción de mi proyecto
|
|
122
|
+
AUTHOR=Tu Nombre
|
|
123
|
+
KEYWORDS=docs,documentation
|
|
124
|
+
|
|
125
|
+
# Despliegue
|
|
126
|
+
BASE_PATH=/mi-proyecto
|
|
127
|
+
NEXT_PUBLIC_SITE_URL=https://tu-usuario.github.io/mi-proyecto
|
|
128
|
+
|
|
129
|
+
# i18n
|
|
130
|
+
DEFAULT_LOCALE=es
|
|
131
|
+
NEXT_PUBLIC_SUPPORTED_LOCALES=es,en
|
|
132
|
+
|
|
133
|
+
# URLs
|
|
134
|
+
TRAILING_SLASH=true
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
<Callout type="warning">
|
|
138
|
+
<strong>Importante</strong>: El archivo <code>.env.local</code> no debe ser commitiado a git. Asegúrate de que esté en tu <code>.gitignore</code>.
|
|
139
|
+
</Callout>
|
|
140
|
+
|
|
141
|
+
## Solución de Problemas
|
|
142
|
+
|
|
143
|
+
### Errores de dependencias
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
# Limpia cache y reinstala
|
|
147
|
+
rm -rf node_modules bun.lockb
|
|
148
|
+
bun install
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Error de build
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
# Limpia .next y rebuild
|
|
155
|
+
rm -rf .next out
|
|
156
|
+
bun run build
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Puerto en uso
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
# Usa un puerto diferente
|
|
163
|
+
bun run dev --port 3001
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
## Siguiente Paso
|
|
167
|
+
|
|
168
|
+
Una vez instalado, consulta [Quick Start](/docs/getting-started/quick-start) para comenzar a escribir tu documentación.
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Quick Start
|
|
3
|
+
description: 'Comienza rápidamente con {{PROJECT_NAME}}'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { Callout, Steps } from 'fumadocs-ui/components';
|
|
7
|
+
import { FileEdit, Globe, CheckCircle2 } from 'lucide-react';
|
|
8
|
+
|
|
9
|
+
# Quick Start
|
|
10
|
+
|
|
11
|
+
Comienza a escribir tu documentación en minutos.
|
|
12
|
+
|
|
13
|
+
<Steps>
|
|
14
|
+
### 1. Copia el contenido template
|
|
15
|
+
|
|
16
|
+
El template incluye un directorio `content-template/` con ejemplos. Cópialo a `content/`:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
cp -r content-template/* content/
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 2. Edita tus primeras páginas
|
|
23
|
+
|
|
24
|
+
Navega a `content/docs/` y edita los archivos `.mdx`:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# Estructura sugerida
|
|
28
|
+
content/
|
|
29
|
+
├── docs/
|
|
30
|
+
│ ├── index.mdx # Página principal
|
|
31
|
+
│ └── getting-started/
|
|
32
|
+
│ ├── index.mdx # Introducción
|
|
33
|
+
│ ├── installation.mdx # Instalación
|
|
34
|
+
│ └── quick-start.mdx # Esta página
|
|
35
|
+
└── en/docs/ # Versión en inglés
|
|
36
|
+
└── (misma estructura)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### 3. Inicia el servidor
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
bun run dev
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Abre [http://localhost:3000](http://localhost:3000).
|
|
46
|
+
|
|
47
|
+
### 4. Personaliza la configuración
|
|
48
|
+
|
|
49
|
+
Edita `.env.local` con tu información:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
PROJECT_NAME=Mi Proyecto
|
|
53
|
+
DESCRIPTION=Mi increíble documentación
|
|
54
|
+
AUTHOR=Tu Nombre
|
|
55
|
+
BASE_PATH=/mi-proyecto
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
</Steps>
|
|
59
|
+
|
|
60
|
+
## Escribir en MDX
|
|
61
|
+
|
|
62
|
+
Fumadocs usa **MDX**, que te permite usar componentes de React directamente en tu markdown.
|
|
63
|
+
|
|
64
|
+
<Callout type="info">
|
|
65
|
+
MDX es markdown con superpoderes. Puedes importar y usar componentes de React.
|
|
66
|
+
</Callout>
|
|
67
|
+
|
|
68
|
+
### Ejemplo básico
|
|
69
|
+
|
|
70
|
+
```mdx
|
|
71
|
+
---
|
|
72
|
+
title: Mi Página
|
|
73
|
+
description: Descripción de la página
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
import { Callout } from 'fumadocs-ui/components';
|
|
77
|
+
import { Info } from 'lucide-react';
|
|
78
|
+
|
|
79
|
+
# Título
|
|
80
|
+
|
|
81
|
+
Contenido normal de markdown.
|
|
82
|
+
|
|
83
|
+
<Callout type="info" icon={<Info />}>
|
|
84
|
+
Este es un callout usando un componente de React.
|
|
85
|
+
</Callout>
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Componentes disponibles
|
|
89
|
+
|
|
90
|
+
Fumadocs UI incluye muchos componentes:
|
|
91
|
+
|
|
92
|
+
- **Callout** - Notas destacadas
|
|
93
|
+
- **Steps** - Pasos numerados
|
|
94
|
+
- **Tabs** - Pestañas de contenido
|
|
95
|
+
- **FileTree** - Árboles de archivos
|
|
96
|
+
- **Preview** - Previsualización de código
|
|
97
|
+
|
|
98
|
+
Ver [Documentación de Fumadocs UI](https://fumadocs.vercel.app/ui) para más.
|
|
99
|
+
|
|
100
|
+
## Agregar una nueva página
|
|
101
|
+
|
|
102
|
+
<Steps>
|
|
103
|
+
### 1. Crea el archivo
|
|
104
|
+
|
|
105
|
+
En `content/docs/` o `content/en/docs/`:
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
# Español
|
|
109
|
+
touch content/docs/mi-tema/index.mdx
|
|
110
|
+
|
|
111
|
+
# Inglés
|
|
112
|
+
touch content/en/docs/my-topic/index.mdx
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### 2. Agrega frontmatter
|
|
116
|
+
|
|
117
|
+
```mdx
|
|
118
|
+
---
|
|
119
|
+
title: Mi Nuevo Tema
|
|
120
|
+
description: Descripción del tema
|
|
121
|
+
---
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### 3. Escribe el contenido
|
|
125
|
+
|
|
126
|
+
```mdx
|
|
127
|
+
# Mi Nuevo Tema
|
|
128
|
+
|
|
129
|
+
Contenido aquí...
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### 4. Verifica
|
|
133
|
+
|
|
134
|
+
El navegador se actualiza automáticamente.
|
|
135
|
+
|
|
136
|
+
</Steps>
|
|
137
|
+
|
|
138
|
+
## Checklist Inicial
|
|
139
|
+
|
|
140
|
+
<Callout type="success">
|
|
141
|
+
<CheckCircle2 className="w-4 h-4 inline mr-2" />
|
|
142
|
+
Instalación completada
|
|
143
|
+
</Callout>
|
|
144
|
+
|
|
145
|
+
<Callout type="success">
|
|
146
|
+
<CheckCircle2 className="w-4 h-4 inline mr-2" />
|
|
147
|
+
Servidor de desarrollo funcionando
|
|
148
|
+
</Callout>
|
|
149
|
+
|
|
150
|
+
<Callout type="success">
|
|
151
|
+
<CheckCircle2 className="w-4 h-4 inline mr-2" />
|
|
152
|
+
Primera página editada
|
|
153
|
+
</Callout>
|
|
154
|
+
|
|
155
|
+
<Callout type="success">
|
|
156
|
+
<CheckCircle2 className="w-4 h-4 inline mr-2" />
|
|
157
|
+
Configuración personalizada
|
|
158
|
+
</Callout>
|
|
159
|
+
|
|
160
|
+
## Siguientes Pasos
|
|
161
|
+
|
|
162
|
+
- **[Características](/docs/features)** - Descubre más componentes
|
|
163
|
+
- **[Configuración](/docs/configuration)** - Personaliza tu sitio
|
|
164
|
+
- **[Despliegue](/docs/deployment)** - Publica tu documentación
|
|
165
|
+
|
|
166
|
+
<Callout type="tip">
|
|
167
|
+
<strong>Tip</strong>: Usa los archivos en <code>content-template/</code> como referencia y luego bórralos cuando hayas creado tu propio contenido.
|
|
168
|
+
</Callout>
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Bienvenido
|
|
3
|
+
description: 'Bienvenido a {{PROJECT_NAME}} - {{DESCRIPTION}}'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { Callout, Steps } from 'fumadocs-ui/components';
|
|
7
|
+
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
|
|
8
|
+
import { FileCode, Terminal } from 'lucide-react';
|
|
9
|
+
|
|
10
|
+
# Bienvenido a {{PROJECT_NAME}}
|
|
11
|
+
|
|
12
|
+
<Callout type="info">
|
|
13
|
+
Este es un template de Fumadocs. Reemplaza este contenido con tu propia documentación.
|
|
14
|
+
</Callout>
|
|
15
|
+
|
|
16
|
+
## Características
|
|
17
|
+
|
|
18
|
+
Este template incluye:
|
|
19
|
+
|
|
20
|
+
- **Soporte bilingüe** - Español e inglés listos para usar
|
|
21
|
+
- **Buscador integrado** - Búsqueda instantánea de contenido
|
|
22
|
+
- **Tema oscuro/claro** - Cambio automático según preferencia del sistema
|
|
23
|
+
- **MDX completo** - Usa componentes de React en tu markdown
|
|
24
|
+
- **GitHub Pages ready** - Configurado para despliegue estático
|
|
25
|
+
|
|
26
|
+
## Comenzando
|
|
27
|
+
|
|
28
|
+
<Steps>
|
|
29
|
+
### Instalación
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# Copia el contenido de content-template/ a content/
|
|
33
|
+
cp -r content-template/* content/
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Desarrollo
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
bun install
|
|
40
|
+
bun run dev
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Abre [http://localhost:3000](http://localhost:3000) para ver tu documentación.
|
|
44
|
+
|
|
45
|
+
### Build
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
bun run build
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Los archivos estáticos se generan en `out/`.
|
|
52
|
+
|
|
53
|
+
## Configuración
|
|
54
|
+
|
|
55
|
+
Edita las variables de entorno en `.env.local`:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
PROJECT_NAME=Mi Proyecto
|
|
59
|
+
DESCRIPTION=Descripción de mi proyecto
|
|
60
|
+
AUTHOR=Tu Nombre
|
|
61
|
+
BASE_PATH=/mi-proyecto
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
<Callout type="warning">
|
|
65
|
+
Recuerda configurar <code>BASE_PATH</code> si despliegas en GitHub Pages con un nombre de repositorio personalizado.
|
|
66
|
+
</Callout>
|
|
67
|
+
|
|
68
|
+
## Siguiente paso
|
|
69
|
+
|
|
70
|
+
Consulta la sección de [Introducción](/docs/getting-started) para más detalles.
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Introduction
|
|
3
|
+
description: 'Introduction to {{PROJECT_NAME}} - {{DESCRIPTION}}'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { Callout, Steps } from 'fumadocs-ui/components';
|
|
7
|
+
import { Terminal } from 'lucide-react';
|
|
8
|
+
|
|
9
|
+
# Introduction
|
|
10
|
+
|
|
11
|
+
Welcome to the **{{PROJECT_NAME}}** documentation.
|
|
12
|
+
|
|
13
|
+
## What is {{PROJECT_NAME}}?
|
|
14
|
+
|
|
15
|
+
<Callout type="info">
|
|
16
|
+
<p><strong>{{DESCRIPTION}}</strong></p>
|
|
17
|
+
</Callout>
|
|
18
|
+
|
|
19
|
+
This template is designed to provide you with a solid foundation for documenting your projects using Fumadocs.
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
Before you begin, make sure you have installed:
|
|
24
|
+
|
|
25
|
+
- **Bun** v1.1.43 or higher
|
|
26
|
+
- **Node.js** v20 or higher (for compatibility)
|
|
27
|
+
|
|
28
|
+
## Quick Installation
|
|
29
|
+
|
|
30
|
+
<Steps>
|
|
31
|
+
### 1. Clone or create your project
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# If using mks-scaffolder
|
|
35
|
+
bunx mks-scaffolder create my-project --template fumadocs
|
|
36
|
+
|
|
37
|
+
# Or if cloning directly
|
|
38
|
+
git clone https://github.com/{{GITHUB_REPO}}.git
|
|
39
|
+
cd my-project
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### 2. Install dependencies
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
bun install
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### 3. Configure environment variables
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
cp .env.example .env.local
|
|
52
|
+
# Edit .env.local with your values
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 4. Start the development server
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
bun run dev
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Open [http://localhost:3000](http://localhost:3000) in your browser.
|
|
62
|
+
|
|
63
|
+
</Steps>
|
|
64
|
+
|
|
65
|
+
## Project Structure
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
.
|
|
69
|
+
├── content/ # Your documentation in MDX
|
|
70
|
+
│ ├── docs/ # Spanish version
|
|
71
|
+
│ └── en/docs/ # English version
|
|
72
|
+
├── messages/ # UI translations
|
|
73
|
+
│ ├── es.json
|
|
74
|
+
│ └── en.json
|
|
75
|
+
├── src/
|
|
76
|
+
│ ├── app/ # Next.js pages
|
|
77
|
+
│ ├── components/ # React components
|
|
78
|
+
│ ├── lib/ # Utilities
|
|
79
|
+
│ └── config/ # Site configuration
|
|
80
|
+
├── public/ # Static files
|
|
81
|
+
└── .env.local # Environment variables (not in git)
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Next Steps
|
|
85
|
+
|
|
86
|
+
- [Installation](/en/docs/getting-started/installation) - Set up your environment
|
|
87
|
+
- [Quick Start](/en/docs/getting-started/quick-start) - Get started quickly
|
|
88
|
+
- [Features](/en/docs/features) - Discover what you can do
|
|
89
|
+
|
|
90
|
+
<Callout type="tip">
|
|
91
|
+
Use <code>content-template/</code> as a reference to create your own documentation structure.
|
|
92
|
+
</Callout>
|