Estructura

La estructura de la guía se compone, entre otras, de las carpetas /source/, con el código fuente, y /dev/, el código generado.

Carpeta /source/

La carpeta /source/ contiene el código fuente de la guía, tanto estilos y JavaScript como el HTML de las páginas de la GEF. Esta carpeta se compone de su vez de las carpetas /assets/, /icons-template/, /pages/ y /templates/.

/assets/

La carpeta /assets/ contiene a su vez los archivos de estilos (/scss/), iconos de la guía (/icons/), funciones de JavaScript (/scripts/), librerías de JavaScript externas (/js-libs/), y archivos empleados con fines demostrativos en la documentación, como imágenes (/img/), estilos (/fw-styles/), y comportamiento (/fw-js/).

/icons-template/

La carpeta /icons-template/ contiene la plantilla para generar el HTML de muestra de los iconos en la documentación, y el resultado generado automáticamente (en /generated/) previo a ser importado en la documentación.

/pages/

La carpeta /pages/ contiene las páginas de la documentación de la guía, en formato .pug.

/templates/

La carpeta /templates/ contiene los elementos HTML en formato .pug que componen la plantilla de la guía: plantilla principl, cabecera, footer, navegaciones.

Carpeta /grunt/

La carpeta /grunt/ contiene el listado de dependencias de paquetes de Grunt (package.json), la configuración de dichos paquetes para que realicen las tareas que queremos (Gruntfile.js) y los paquetes que automáticamente instala Node cuando ejecutamos el comando npm install (/node_modules/).

Carpeta /environment/

En esta carpeta, que está separada para ser cómoda de alterar, está el archivo de configuración environment.js, donde podemos cambiar la ruta absoluta de los archivos y regenerar el código para subirlo a un servidor.

Carpeta /dev/

En la carpeta /dev/ se generan automáticamente los HTML, CSS y JS estáticos que conforman la guía. El servidor local que monta Grunt tiene como punto de partida esta carpeta.

Carpeta /build/

En la carpeta /build/ se genera la carpeta /gef/, que se sube directamente al servidor final y que contiene la CSS, JS e iconos finales.

Subir