Swanix - Tool Docs

Libreria de documentación para crear nuevos módulos personalizados de Swanix.

Requisitos

Antes de iniciar debes tener previamente instalados:

• Git
• Node.js

Instalación

En una carpeta vacía de tu equipo escribe el siguiente comando en la terminal:

git clone https://github.com/swanix/tool-docs.git

Cuando se termine de clonar el proyecto escribe el comando:

npm install

Este comando instalará las dependencias de Node.js especificadas en el archivo package.json (en esencia se trata de Browsersync para automatizar algunas tareas de desarrollo).

Las dependencias se instalan en la carpeta node_modules (creada automáticamente con el comando npm install) y luego de instaladas podemos utilizar el siguiente comando para ver nuestra página de inicio:

npm run serve

Este comando ejecuta un servidor estático que apunta a la carpeta docs este abrirá el navegador de forma automática mostrando el sitio de prueba con ejemplos de la librería.

Créditos

Tool Docs está basado en diferentes librerías open source:

Docsify:

• Docsify https://docsify.js.org/
• Docsify Pagination https://github.com/imyelo/docsify-pagination
• Docsify Tabs https://jhildenbiddle.github.io/docsify-tabs/
• Docsify Copy Code https://github.com/jperasmus/docsify-copy-code
• Docsify Mustache https://docsify-mustache.github.io/

Otras Librerías

• Clipboard.js https://clipboardjs.com/
• Hint.css https://github.com/chinchang/hint.css
• List.js https://listjs.com/