Home | Screenshots | Downloads | GitHub | Contact
AutoSite wordmark

The Structure of a Project

AutoSite projects consist of four distinct folders, pages, includes, templates, and out. You'll see the first three when the project is made, and the fourth is generated on first build. The first three folders are naturally where you'll store your site's assets, while the fourth will contain the finished site that you upload to your web host.

[#] The templates Folder

Templates are full fat HTML documents (layouts, styling, metadata, all of it), but with the bits that change page to page replaced with attribute tokens, or placeholders, essentially. By themselves, templates do nothing and won't appear on your site. An input page needs to be set to use the template in question in order for a page using that layout to be built.

[#] The pages Folder

The pages folder contains the raw input pages of your site, structured in folders exactly like they'd be on your web server. These are your site's pages stripped down to only the stuff unique to them. Attributes are set on the input pages. Page content, of course, goes on the input pages.

When AutoSite goes to build your site, it will mirror the folder structure in pages into the output folder, and each of the input pages will be replaced by their chosen template, with that page's attributes and content filling in the tokens in the template.

[#] The includes Folder

The includes folder is special. AutoSite simply merges this into the output folder without touching a single thing inside. This can be used for specific HTML pages you don't want AutoSite to process alongside your site's general assets.

You'll need to keep an additional copy of any folder containing both input pages and assets in includes. In other words, if you have an about/ directory on your site with pictures and with pages, you'll need an about folder in pages and one in includes, the former containing the page to be built and the latter containing the pictures.

[#] The out Folder

Finally, when you build your site, you'll find a fourth folder in the project directory, out. This is your site after everything's been built and merged. This folder's contents are what you'll want to upload to your web server.

One thing to note is that your out folder will contain a second copy of everything in includes, as said, thus doubling the project's size. For larger sites with large downloads and assets, be mindful of your space requirements if you have a small drive or you're using cloud storage to sync your AutoSite projects.