Jade

El motor de plantillas Jade gestiona las plantillas HTML y la navegación de la documentación de la GEF.

Para más información sobre el funcionamiento y configuración de Jade, consulta la documentación oficial.

Carpeta /templates/

Contiene los archivos .pug que forman parte de la plantilla principal de la documentación, como la cabecera, la navegación o el pie.

Layout, foot y variables principales

El archivo layout.pug contiene la estructura principal de la documentación, con distintos condicionales que cargan distintas hojas de estilo o módulos en función de la sección.

Las variables principales que se emplean en layout.pug son layout, que indica la sección para la cual se está renderizando la página (portal, campus, demos…), lang, que indica el idioma, y activePage y activeGroup, que indican la página y el grupo de navegación activos.

Navegaciones

Cada navegación cuenta con un archivo propio. El archivo topbar.pug indica el código y navegación superior; el archivo secondary-nav.pug contiene la navegación secundaria de la página, con sus versiones para Campus (secondary-nav-campus.pug) y para la documentación (docs-nav.pug). Estas navegaciones secundarias comparten unos mixins de Jade (nav-mixins.pug) que permiten la generación rápida de los enlaces de navegación.

Carpeta /pages/ y /es/

Dentro de la carpeta /pages/ se encuentran todos los contenidos de la documentación.

La carpeta /es/ contiene las páginas en español. Para generar nuevas traducciones, se debe duplicar esta carpeta. Para más información sobre traducciones, consulta la sección correspondiente.

Carpetas /guide/ y /campus/

La carpeta /guide/ incluye toda la documentación de cada uno de los componentes que forman parte de la guía de estilo.

En la carpeta /campus/ se encuentra la documuentación replicada, mediante la función extend, y se amplía o sustituye la documentación cuando es necesario, mediante el uso de la función block.

Carpeta /demos/

Contiene distintos ejemplos de uso que, por sus características, necesitan verse a pantalla completa, como la navegación secundaria, el pie o la cabecera.

Carpeta /docs/

Incluye documentación para el mantenimiento de la guía.

Carpeta /resources/

En esta carpeta se incluyen distintos recursos que, aunque no forman parte de la guía, pueden ser de utilidad en los distintos desarrollos frontend.

Función :escape

La función :escape declarada en el archivo Gruntfile.js permite escapar bloques de código, sustituyendo los carácteres de etiqueta por sus equivalentes en entidades HTML.

Subir