04 File structure - pimmey/axala-docs GitHub Wiki

├── about
├── app
│   ├── assets/
│       ├── css/
│       ├── fonts/
│       ├── images/
│       ├── js/
│   ├── gulp/
│   ├── libs/
│   ├── mailer/
│   ├── src/
│       ├── pug
│       ├── sass
├── cases/
├── contact/
├── favicons/
├── home-*/
├── journal/
├── pricing/
├── stories/

app

Everything, except HTML files, is located under the app/ directory.

assets

• css contains compiled axala.css and linea.css
• fonts contains the font files
• images contains the page's images, divided by category. Put all of your images in this directory, as that's where they get optimised via Gulp tasks
• js contains the core JavaScript file, config file and various custom scripts

favicons

This directory contains favicons. And a file called manifest.json, which you should edit by placing your company's name in it.

gulp

You can find gulp commands here, they are being injected into gulpfile.js in the project's root.

libs

The place for the libraries used in this template.

mailer

PHP files that are needed to make the contact form function are located here. In templates directory you'll be able to find the predesigned mail templates.

about, cases, contact, etc.

These are all directories created in order to have pretty URLs. Each of these directories will have a index.html file, which is accessed by default when you navigate to that directory.

src

pug

• ./ (i.e. the directory itself) is the home directory of all your .pug files
• components contains reusable Pug components
• layout contains header and footer layouts
• pages is a directory for the pages source

sass

• ./ contains the main axala.scss file as well as all of its components
• components holds styles for various components of the theme
• pages contains page-specific styles