Inicio rápido

¡Bienvenido a TechHub, la base de conocimiento técnico! Esta guía te ayudará a conocer rápidamente la estructura del proyecto, arrancar el entorno de desarrollo local y publicar tu primera versión de la documentación.

Requisitos de entorno

• Node.js versión 18 o superior
• Cualquier gestor de paquetes: npm / pnpm / yarn

Instalar dependencias

npm install

Iniciar el servidor de desarrollo

npm run docs:dev

Tras iniciarlo, accede a http://localhost:5173; al editar cualquier archivo Markdown se actualiza la vista previa en tiempo real mediante hot reload.

Estructura de directorios

.
├── docs/
│   ├── .vitepress/          # Configuración y tema de VitePress
│   │   ├── config.mjs       # Configuración global del sitio (navegación/barra lateral/búsqueda, etc.)
│   │   └── theme/           # Personalización del tema (estilos, componentes)
│   ├── public/              # Recursos estáticos (imágenes, favicon, etc.)
│   ├── index.md             # Página de inicio
│   ├── project/             # Documentación propia del proyecto de este sitio
│   ├── frontend/            # Tecnología de frontend
│   ├── backend/             # Tecnología de backend
│   ├── languages/           # Lenguajes de programación
│   ├── ai/                  # Dirección de IA
│   ├── paths/               # Rutas de aprendizaje
│   ├── journals/            # Registros de procesos (diarios/errores/retrospectivas)
│   ├── books/               # Notas de lectura
│   └── papers/              # Colección de literatura
├── scripts/                 # Scripts de despliegue/rollback/registro de cambios
├── package.json
└── README.md

Añadir un documento nuevo

1. Crea un archivo .md en el directorio correspondiente, por ejemplo docs/guide/example.md;
2. Escribe la metainformación Frontmatter en la parte superior del archivo:

---
title: 示例文档
description: 本文档用于演示基础用法。
---

# 示例文档

这里是正文内容。

3. Añade la página a la barra lateral (edita la configuración de sidebar en docs/.vitepress/config.mjs).

Construir el sitio estático

npm run docs:build

Los artefactos de construcción se generan en docs/.vitepress/dist y pueden alojarse directamente en cualquier servidor estático o CDN.

Previsualizar el resultado de la construcción localmente

npm run docs:preview

---

Siguiente paso

• Para aprender a redactar contenidos documentales más completos, consulta la Guía de redacción.
• ¿Listo para publicar la documentación? Consulta Despliegue y publicación.