didor-docs v0.5.0

Generador de documentación

Didor docs es un generador de documentación online. Utiliza docsify como base, y se han creado algunos plugins para añadirle características y funcionalidades nuevas.

Links

• Documentación

Características

• Preocúpate solo de los contenidos, solo archivos .md
• Sencillo y rápido de utilizar.
• Documenta tu API con ejemplos en vivo.
• Documenta tu guía de estilos.
• Visualiza tu documentación con actualización en vivo mientras desarrollas.
• Visualiza tu documentación en tu repositorio desde cualquier sitio web.

Visualizar tu documentación durante el desarrollo

Didor-docs incluye un servidor para poder visualizar tu documentación en local mientras desarrollas, con actualización en vivo. No es recomendable utilizarlo para mostrar tu documentación en producción.

El primer paso es instalar didor-docs como dependencia en tu proyecto.

$ npm install didor-docs --save-dev

En nuestro archivo package.json añadimos el siguiente script.

"scripts": {
  "docs": "didor-docs /docs",
}

Siendo /docs la ruta del directorio donde tendremos nuestra documentación.

Aparte de la ruta, también puedes configurar los siguientes parámetros:

didor-docs /docs -o         # Abre la documentación en tu navegador por defecto (default: false)
didor-docs /docs -p 3000    # Indica el puerto donde se mostrará tu documentación (default: 3000)
didor-docs /docs -l 35729   # Indica el puerto liveReload (default: 35729)

Ejemplos

En la carpeta 'examples' tienes ejemplos con diferentes tipos de configuraciones.

Proyecto simple

Necesitas al menos tres archivos para comenzar tu documentación:

docs/           # Directorio donde están tu documentación
|_ _sidebar.md  # Links mostrados en la barra lateral
|_ config.js    # Archivo para configurar docsify y los plugins
|_ home.md      # Página de inicio de tu documentación

La configuración mínima es indicar el nombre de tu proyecto. Puedes añadir todas las propiedades de configuración que tiene por defecto docsify. En la documentación podrás ver las específicas de cada plugin personalizado.

// config.js

window.$docsify = {
  name: 'Didor Docs',
};

Licencia

Este proyecto se distribuye bajo una licencia MIT.