Project structure
| Folder / File name | Description |
|---|---|
| furnitor | Folder contains all template source and production files. |
| furnitor / site | This folder holds all template source files like .md, .html, .yml, .scss, .js that
are then processed (compiled / minified) to dist folder.
|
| furnitor / dist | Folder contains all template distribution files like .html, .css, .js that have
been processed (compiled / minified) from site folder using Node.js and Gulp.
|
| furnitor / dist / vendors | This folder contains all vendor plugins' .js / .css files. |
| furnitor / package.json | File contains meta data about your app or module. Most importantly, it includes the list of dependencies to install from npm when running npm install. |
| furnitor / gulpfile.js | Configuration file for Gulp library. It contains all tasks you want to perform with Gulp. Learn more about it from Working with Gulp section or official Gulp documentation. |
| furnitor / site/_assets / js | This folder contains main theme.js that is processed (compiled /
minified) to dist/js/theme.min.js.
|
| furnitor / site/_assets / scss | This folder contains all project sass files that are compiled and
minified to styles in dist/css/ folder.
|
| furnitor / scss / | This folder contains all .scss of bootstrap framework
|
| furnitor / js / | This folder contains all .js of bootstrap framework
|
Note: if you do not use Pro Front-End setup with Node.js and Gulp and want directly edit html / css / js files you should be looking into dist folder.
Whether you work with Node.js and Gulp or not you can still take advantage of preprocessors for HTML and CSS.
In
this case you might want to learn how to use Jekyll
and Sass.