create-bunspace 0.1.1 → 0.2.1

package/templates/fumadocs/content-template/docs/getting-started/index.mdx

@@ -0,0 +1,92 @@
+---
+title: Introducción
+description: 'Introducción a {{PROJECT_NAME}} - {{DESCRIPTION}}'
+---
+
+import { Callout, Steps } from 'fumadocs-ui/components';
+import { Terminal } from 'lucide-react';
+
+# Introducción
+
+Bienvenido a la documentación de **{{PROJECT_NAME}}**.
+
+## ¿Qué es {{PROJECT_NAME}}?
+
+<Callout type="info">
+  <p><strong>{{DESCRIPTION}}</strong></p>
+</Callout>
+
+Este template está diseñado para proporcionarte una base sólida para documentar tus proyectos usando Fumadocs.
+
+## Requisitos Previos
+
+Antes de comenzar, asegúrate de tener instalado:
+
+- **Bun** v1.1.43 o superior
+- **Node.js** v20 o superior (compatibilidad)
+
+## Instalación Rápida
+
+<Steps>
+### 1. Clona o crea tu proyecto
+
+```bash
+# Si usas mks-scaffolder
+bunx mks-scaffolder create mi-proyecto --template fumadocs
+
+# O si clonas directamente
+git clone https://github.com/{{GITHUB_REPO}}.git
+cd mi-proyecto
+```
+
+### 2. Instala dependencias
+
+```bash
+bun install
+```
+
+### 3. Configura las variables de entorno
+
+```bash
+cp .env.example .env.local
+# Edita .env.local con tus valores
+```
+
+### 4. Inicia el servidor de desarrollo
+
+```bash
+bun run dev
+```
+
+Abre [http://localhost:3000](http://localhost:3000) en tu navegador.
+
+</Steps>
+
+## Estructura del Proyecto
+
+```
+.
+├── content/              # Tu documentación en MDX
+│   ├── docs/            # Versión en español
+│   └── en/docs/         # Versión en inglés
+├── messages/            # Traducciones de la UI
+│   ├── es.json
+│   └── en.json
+├── src/
+│   ├── app/            # Páginas de Next.js
+│   ├── components/     # Componentes React
+│   ├── lib/            # Utilidades
+│   └── config/         # Configuración del sitio
+├── public/             # Archivos estáticos
+└── .env.local          # Variables de entorno (no en git)
+```
+
+## Próximos Pasos
+
+- [Configuración](/docs/getting-started/installation) - Configura tu entorno
+- [Quick Start](/docs/getting-started/quick-start) - Comienza rápidamente
+- [Características](/docs/features) - Descubre lo que puedes hacer
+
+<Callout type="tip">
+  Usa <code>content-template/</code> como referencia para crear tu propia estructura de documentación.
+</Callout>

package/templates/fumadocs/content-template/docs/getting-started/installation.mdx

@@ -0,0 +1,168 @@
+---
+title: Instalación
+description: 'Instalación y configuración de {{PROJECT_NAME}}'
+---
+
+import { Callout, Steps, Tabs, Tab } from 'fumadocs-ui/components';
+import { Terminal, FileCode } from 'lucide-react';
+
+# Instalación
+
+Guía completa de instalación para {{PROJECT_NAME}}.
+
+## Opciones de Instalación
+
+<Tabs items={['Usando mks-scaffolder', 'Manual', 'GitHub Clone']}>
+  <Tab value="Usando mks-scaffolder">
+    <Steps>
+    ### Crea un nuevo proyecto
+
+    ```bash
+    bunx mks-scaffolder create mi-proyecto --template fumadocs
+    ```
+
+    Responde las preguntas interactivas:
+    - **Project name**: `mi-proyecto`
+    - **Description**: Descripción de tu proyecto
+    - **Author**: Tu nombre
+    - **Base path**: `/mi-proyecto` (para GitHub Pages)
+
+    ### Entra al directorio
+
+    ```bash
+    cd mi-proyecto
+    ```
+
+    ### Instala dependencias e inicia
+
+    ```bash
+    bun install
+    bun run dev
+    ```
+
+    </Steps>
+  </Tab>
+
+  <Tab value="Manual">
+    <Steps>
+    ### Crea el proyecto
+
+    ```bash
+    mkdir mi-proyecto && cd mi-proyecto
+    bun init -y
+    ```
+
+    ### Instala dependencias
+
+    ```bash
+    bun add next fumadocs-ui fumadocs-mdx next-intl lucide-react
+    bun add -d @types/node @types/react @types/react-dom
+    ```
+
+    ### Copia los archivos del template
+
+    Copia el contenido de `mks-fumadocs-template/` a tu proyecto.
+
+    ### Configura .env.local
+
+    ```bash
+    PROJECT_NAME=Mi Proyecto
+    DESCRIPTION=Descripción
+    AUTHOR=Tu Nombre
+    BASE_PATH=/mi-proyecto
+    ```
+
+    </Steps>
+  </Tab>
+
+  <Tab value="GitHub Clone">
+    <Steps>
+    ### Clona el repositorio
+
+    ```bash
+    git clone https://github.com/{{GITHUB_REPO}}.git mi-proyecto
+    cd mi-proyecto
+    ```
+
+    ### Instala dependencias
+
+    ```bash
+    bun install
+    ```
+
+    ### Configura el proyecto
+
+    Edita `.env.local` con tus valores.
+
+    </Steps>
+  </Tab>
+</Tabs>
+
+## Verificación
+
+<Callout type="success">
+  Para verificar que todo funciona correctamente, ejecuta:
+
+  ```bash
+  bun run build
+  bun run start
+  ```
+
+  Deberías ver la documentación en <code>http://localhost:3000</code>
+</Callout>
+
+## Variables de Entorno
+
+Crea un archivo `.env.local` en la raíz del proyecto:
+
+```bash
+# Información del proyecto
+PROJECT_NAME=Mi Proyecto
+DESCRIPTION=Descripción de mi proyecto
+AUTHOR=Tu Nombre
+KEYWORDS=docs,documentation
+
+# Despliegue
+BASE_PATH=/mi-proyecto
+NEXT_PUBLIC_SITE_URL=https://tu-usuario.github.io/mi-proyecto
+
+# i18n
+DEFAULT_LOCALE=es
+NEXT_PUBLIC_SUPPORTED_LOCALES=es,en
+
+# URLs
+TRAILING_SLASH=true
+```
+
+<Callout type="warning">
+  <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>.
+</Callout>
+
+## Solución de Problemas
+
+### Errores de dependencias
+
+```bash
+# Limpia cache y reinstala
+rm -rf node_modules bun.lockb
+bun install
+```
+
+### Error de build
+
+```bash
+# Limpia .next y rebuild
+rm -rf .next out
+bun run build
+```
+
+### Puerto en uso
+
+```bash
+# Usa un puerto diferente
+bun run dev --port 3001
+```
+
+## Siguiente Paso
+
+Una vez instalado, consulta [Quick Start](/docs/getting-started/quick-start) para comenzar a escribir tu documentación.

package/templates/fumadocs/content-template/docs/getting-started/quick-start.mdx

@@ -0,0 +1,168 @@
+---
+title: Quick Start
+description: 'Comienza rápidamente con {{PROJECT_NAME}}'
+---
+
+import { Callout, Steps } from 'fumadocs-ui/components';
+import { FileEdit, Globe, CheckCircle2 } from 'lucide-react';
+
+# Quick Start
+
+Comienza a escribir tu documentación en minutos.
+
+<Steps>
+### 1. Copia el contenido template
+
+El template incluye un directorio `content-template/` con ejemplos. Cópialo a `content/`:
+
+```bash
+cp -r content-template/* content/
+```
+
+### 2. Edita tus primeras páginas
+
+Navega a `content/docs/` y edita los archivos `.mdx`:
+
+```bash
+# Estructura sugerida
+content/
+├── docs/
+│   ├── index.mdx              # Página principal
+│   └── getting-started/
+│       ├── index.mdx          # Introducción
+│       ├── installation.mdx   # Instalación
+│       └── quick-start.mdx    # Esta página
+└── en/docs/                    # Versión en inglés
+    └── (misma estructura)
+```
+
+### 3. Inicia el servidor
+
+```bash
+bun run dev
+```
+
+Abre [http://localhost:3000](http://localhost:3000).
+
+### 4. Personaliza la configuración
+
+Edita `.env.local` con tu información:
+
+```bash
+PROJECT_NAME=Mi Proyecto
+DESCRIPTION=Mi increíble documentación
+AUTHOR=Tu Nombre
+BASE_PATH=/mi-proyecto
+```
+
+</Steps>
+
+## Escribir en MDX
+
+Fumadocs usa **MDX**, que te permite usar componentes de React directamente en tu markdown.
+
+<Callout type="info">
+  MDX es markdown con superpoderes. Puedes importar y usar componentes de React.
+</Callout>
+
+### Ejemplo básico
+
+```mdx
+---
+title: Mi Página
+description: Descripción de la página
+---
+
+import { Callout } from 'fumadocs-ui/components';
+import { Info } from 'lucide-react';
+
+# Título
+
+Contenido normal de markdown.
+
+<Callout type="info" icon={<Info />}>
+  Este es un callout usando un componente de React.
+</Callout>
+```
+
+### Componentes disponibles
+
+Fumadocs UI incluye muchos componentes:
+
+- **Callout** - Notas destacadas
+- **Steps** - Pasos numerados
+- **Tabs** - Pestañas de contenido
+- **FileTree** - Árboles de archivos
+- **Preview** - Previsualización de código
+
+Ver [Documentación de Fumadocs UI](https://fumadocs.vercel.app/ui) para más.
+
+## Agregar una nueva página
+
+<Steps>
+### 1. Crea el archivo
+
+En `content/docs/` o `content/en/docs/`:
+
+```bash
+# Español
+touch content/docs/mi-tema/index.mdx
+
+# Inglés
+touch content/en/docs/my-topic/index.mdx
+```
+
+### 2. Agrega frontmatter
+
+```mdx
+---
+title: Mi Nuevo Tema
+description: Descripción del tema
+---
+```
+
+### 3. Escribe el contenido
+
+```mdx
+# Mi Nuevo Tema
+
+Contenido aquí...
+```
+
+### 4. Verifica
+
+El navegador se actualiza automáticamente.
+
+</Steps>
+
+## Checklist Inicial
+
+<Callout type="success">
+  <CheckCircle2 className="w-4 h-4 inline mr-2" />
+  Instalación completada
+</Callout>
+
+<Callout type="success">
+  <CheckCircle2 className="w-4 h-4 inline mr-2" />
+  Servidor de desarrollo funcionando
+</Callout>
+
+<Callout type="success">
+  <CheckCircle2 className="w-4 h-4 inline mr-2" />
+  Primera página editada
+</Callout>
+
+<Callout type="success">
+  <CheckCircle2 className="w-4 h-4 inline mr-2" />
+  Configuración personalizada
+</Callout>
+
+## Siguientes Pasos
+
+- **[Características](/docs/features)** - Descubre más componentes
+- **[Configuración](/docs/configuration)** - Personaliza tu sitio
+- **[Despliegue](/docs/deployment)** - Publica tu documentación
+
+<Callout type="tip">
+  <strong>Tip</strong>: Usa los archivos en <code>content-template/</code> como referencia y luego bórralos cuando hayas creado tu propio contenido.
+</Callout>

package/templates/fumadocs/content-template/docs/index.mdx

@@ -0,0 +1,70 @@
+---
+title: Bienvenido
+description: 'Bienvenido a {{PROJECT_NAME}} - {{DESCRIPTION}}'
+---
+
+import { Callout, Steps } from 'fumadocs-ui/components';
+import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
+import { FileCode, Terminal } from 'lucide-react';
+
+# Bienvenido a {{PROJECT_NAME}}
+
+<Callout type="info">
+  Este es un template de Fumadocs. Reemplaza este contenido con tu propia documentación.
+</Callout>
+
+## Características
+
+Este template incluye:
+
+- **Soporte bilingüe** - Español e inglés listos para usar
+- **Buscador integrado** - Búsqueda instantánea de contenido
+- **Tema oscuro/claro** - Cambio automático según preferencia del sistema
+- **MDX completo** - Usa componentes de React en tu markdown
+- **GitHub Pages ready** - Configurado para despliegue estático
+
+## Comenzando
+
+<Steps>
+### Instalación
+
+```bash
+# Copia el contenido de content-template/ a content/
+cp -r content-template/* content/
+```
+
+### Desarrollo
+
+```bash
+bun install
+bun run dev
+```
+
+Abre [http://localhost:3000](http://localhost:3000) para ver tu documentación.
+
+### Build
+
+```bash
+bun run build
+```
+
+Los archivos estáticos se generan en `out/`.
+
+## Configuración
+
+Edita las variables de entorno en `.env.local`:
+
+```bash
+PROJECT_NAME=Mi Proyecto
+DESCRIPTION=Descripción de mi proyecto
+AUTHOR=Tu Nombre
+BASE_PATH=/mi-proyecto
+```
+
+<Callout type="warning">
+  Recuerda configurar <code>BASE_PATH</code> si despliegas en GitHub Pages con un nombre de repositorio personalizado.
+</Callout>
+
+## Siguiente paso
+
+Consulta la sección de [Introducción](/docs/getting-started) para más detalles.

package/templates/fumadocs/content-template/en/docs/getting-started/index.mdx

@@ -0,0 +1,92 @@
+---
+title: Introduction
+description: 'Introduction to {{PROJECT_NAME}} - {{DESCRIPTION}}'
+---
+
+import { Callout, Steps } from 'fumadocs-ui/components';
+import { Terminal } from 'lucide-react';
+
+# Introduction
+
+Welcome to the **{{PROJECT_NAME}}** documentation.
+
+## What is {{PROJECT_NAME}}?
+
+<Callout type="info">
+  <p><strong>{{DESCRIPTION}}</strong></p>
+</Callout>
+
+This template is designed to provide you with a solid foundation for documenting your projects using Fumadocs.
+
+## Prerequisites
+
+Before you begin, make sure you have installed:
+
+- **Bun** v1.1.43 or higher
+- **Node.js** v20 or higher (for compatibility)
+
+## Quick Installation
+
+<Steps>
+### 1. Clone or create your project
+
+```bash
+# If using mks-scaffolder
+bunx mks-scaffolder create my-project --template fumadocs
+
+# Or if cloning directly
+git clone https://github.com/{{GITHUB_REPO}}.git
+cd my-project
+```
+
+### 2. Install dependencies
+
+```bash
+bun install
+```
+
+### 3. Configure environment variables
+
+```bash
+cp .env.example .env.local
+# Edit .env.local with your values
+```
+
+### 4. Start the development server
+
+```bash
+bun run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) in your browser.
+
+</Steps>
+
+## Project Structure
+
+```
+.
+├── content/              # Your documentation in MDX
+│   ├── docs/            # Spanish version
+│   └── en/docs/         # English version
+├── messages/            # UI translations
+│   ├── es.json
+│   └── en.json
+├── src/
+│   ├── app/            # Next.js pages
+│   ├── components/     # React components
+│   ├── lib/            # Utilities
+│   └── config/         # Site configuration
+├── public/             # Static files
+└── .env.local          # Environment variables (not in git)
+```
+
+## Next Steps
+
+- [Installation](/en/docs/getting-started/installation) - Set up your environment
+- [Quick Start](/en/docs/getting-started/quick-start) - Get started quickly
+- [Features](/en/docs/features) - Discover what you can do
+
+<Callout type="tip">
+  Use <code>content-template/</code> as a reference to create your own documentation structure.
+</Callout>