Mi Documentación

Appearance

Instalación ​

Esta guía te mostrará cómo instalar y configurar el proyecto paso a paso.

Requisitos del Sistema ​

Antes de comenzar, verifica que tu sistema cumpla con los siguientes requisitos:

  • Node.js: versión 18.0 o superior
  • npm: versión 9.0 o superior (o yarn/pnpm)
  • Sistema Operativo: Windows, macOS o Linux

Verificar Versiones ​

Ejecuta estos comandos para verificar tus versiones:

bash
node --version
npm --version

Instalación ​

1. Clonar el Repositorio ​

bash
git clone https://github.com/tu-usuario/tu-repo.git
cd tu-repo

2. Instalar Dependencias ​

Usando npm:

bash
npm install

Usando yarn:

bash
yarn install

Usando pnpm:

bash
pnpm install

3. Iniciar el Servidor de Desarrollo ​

bash
npm run docs:dev

El servidor se iniciará en http://localhost:5173

Estructura del Proyecto ​

Después de la instalación, tu proyecto tendrá la siguiente estructura:

docu/
├── docs/
│   ├── .vitepress/
│   │   └── config.js         # Configuración de VitePress
│   ├── guia/
│   │   ├── introduccion.md
│   │   ├── inicio-rapido.md
│   │   ├── instalacion.md
│   │   ├── caracteristicas.md
│   │   └── configuracion.md
│   ├── api/
│   │   ├── referencia.md
│   │   ├── metodos.md
│   │   └── ejemplos.md
│   └── index.md              # Página de inicio
├── package.json
└── README.md

Configuración Inicial ​

Personalizar el Título y Descripción ​

Edita el archivo docs/.vitepress/config.js:

javascript
export default defineConfig({
  title: "Tu Título",
  description: "Tu descripción",
  // ... más configuración
})

Agrega tu logo en docs/.vitepress/public/logo.svg y actualiza la configuración:

javascript
themeConfig: {
  logo: '/logo.svg',
  // ... más configuración
}

Solución de Problemas ​

Error: Puerto 5173 en uso ​

Si el puerto está en uso, puedes especificar uno diferente:

bash
npm run docs:dev -- --port 3000

Error: Módulo no encontrado ​

Limpia la caché e instala nuevamente:

bash
rm -rf node_modules package-lock.json
npm install

Error: Versión de Node.js ​

Asegúrate de usar Node.js 18 o superior. Puedes usar nvm para gestionar versiones:

bash
nvm install 18
nvm use 18

Construcción para Producción ​

Para construir tu documentación para producción:

bash
npm run docs:build

Los archivos se generarán en docs/.vitepress/dist/

Vista Previa de la Construcción ​

Para previsualizar la construcción:

bash
npm run docs:preview

Despliegue ​

VitePress genera HTML estático que puede ser desplegado en cualquier servidor web o servicio de hosting estático:

Ejemplo: GitHub Pages ​

Agrega este script a tu package.json:

json
{
  "scripts": {
    "deploy": "npm run docs:build && gh-pages -d docs/.vitepress/dist"
  }
}

Próximos Pasos ​

Documentación del proyecto

Copyright © 2025