Trio Icon
Trio v6.0.3
Documentation is evolving and is a WIP

Project Structure

Should your projects require additional folders to support tasks that fall outside of Trio's build and release workflows, such a those to bundle your site's runtime JavaScript for example, please create them as children of the root/source/ folder and add them to Trio's ignore configuration property to prevent them from polluting Trio's metadata and from interfering with Trio's build and release workflows.

The following describes a Trio project's file and folder structure:

Project Folders And Files

root/.cache/

Contains metadata that Trio maintains and uses to implement incremental building of your project.

root/trio.json

Project configuration file. See Configuration for more information.

root/trio.manifest.json

File which contains collections of metadata that are generated every time Trio builds the project.

root/public/

Folder targeted by the build command. See Command Line for details.

root/release/

Folder targeted by the release command. See Command Line for details.

root/source/

Contains the following folders which are used for the development of your web site.

root/source/callbacks/

Contains tag-based callback modules, which are referenced by HTML tags in templates, fragments and includes using the data-trio-callback tag attribute. See Tag-Based Callbacks for more information.

root/source/css/

Contains .css files. See SCSS/SASS/CSS for more information.

root/source/data/

Contains JSON data files that are exposed to tag-based callbacks. See JSON Data for more information.

root/source/etc/

Contains files, such as favicon.ico, 404.html, robots.txt, sitemaps, .nojekyll, .etc, for example, that are copied "as is" to the site's root folder.

root/source/filters/

Contains collection filter function modules introduced in v2.0.0.. See Collections for more information.

root/source/fragments/

Contains .md and .html fragment files and folders. See Fragment for more information.

root/source/fragments/articles/

Contains blog-specific article .md and .html fragment files and folders. See Blogging for more information.

root/source/includes/

Contains .md and .html include files. See Include for more information.

root/source/lib/

Contains JavaScript modules that are required by tag-based callback modules and collection filter function modules. Introduced in v4.0.0. See Tag-Based Callbacks and Collections for more information.

root/source/media/

Contains media specific files (e.g. .jpg, .gif, .pdf, .etc).

root/source/sass/

Contains .sass and .scsss files. See SCSS/SASS/CSS for more information.

root/source/scripts/

Contains run-time JavaScript files. When building your site Trio copies these JavaScript files to either root/public/scripts or root/release/scripts.

If your site uses a JavaScript bundler (e.g. Parcel, Browserify, Webpack) to package its runtime JavaScript then do not host those modules in root/source/scripts. Instead, create a new folder, jsBundle for example, in root/source/ and host them there. You must also configure Trio to ignore these folders to prevent them from polluting Trio's metadata and from interfering with Trio's build and release workflows. See above for more information.

root/source/templates/

Contains .html template files.

See Also