¿Cómo tener un proyecto bien documentado?
Hola lectores,
Hoy vamos a hablar un poco sobre la creación de este sitio y cómo se hizo usando
Simplifica el proceso de construcción de sitios estáticos para documentación técnica, haciendo más fácil para los desarrolladores y equipos de proyectos gestionar y presentar documentación en línea.
Algunas características clave de Docusaurus incluyen:
Estructura de Documentación Estándar
Docusaurus proporciona una estructura predefinida para organizar la documentación, incluyendo soporte para múltiples idiomas, categorías y versionado.
Escritura en Markdown e integración con React
La documentación se escribe en Markdown, un lenguaje de marcado ligero y fácil de aprender. Esto facilita el formato y la escritura, permitiendo que los desarrolladores se concentren en el contenido, pero permite la incorporación de componentes React, proporcionando flexibilidad e interactividad cuando sea necesario.
Búsqueda Integrada
Docusaurus incluye funcionalidades de búsqueda integradas para ayudar a los usuarios a encontrar rápidamente la información deseada.
Tema Personalizable
Aunque Docusaurus viene con un tema predeterminado limpio y responsivo, los usuarios pueden personalizar la apariencia del sitio de documentación según sea necesario.
Integración con Versionado
Es posible organizar documentación para diferentes versiones de un proyecto, facilitando la referencia a la documentación correspondiente a una versión específica del software.
Para iniciar el proyecto instala Node.js en la última versión.
sudo apt-get install nvm -y
nvm install node
node --version
v21.5.0
npx create-docusaurus@latest my-site classic
cd my-site
# Construyendo el proyecto
npm run build # generará el código estático
npm run serve
En el navegador localhost:3000
La carpeta my-site tiene esta estructura
.
├── babel.config.js
├── blog
├── build
├── docs # Las documentaciones de ejemplo están aquí
├── docusaurus.config.js
├── node_modules
├── package.json
├── package-lock.json
├── README.md
├── sidebars.js
├── src
└── static
Por supuesto que puedes hacer todos estos comandos en el propio repositorio de tu proyecto y creará la carpeta my-site con la estructura de arriba.
Usa el modelo en la carpeta docs y crea la documentación del proyecto.
Cada vez que quieras ver la documentación ejecuta npm run serve
¡También puedes montar un pipeline de entrega para ejecutar el sitio en algún lugar y tener siempre la documentación más actualizada para tu equipo y tus clientes!