For consistency all our projects use the same template as a base. Our repositories come pre-installed with a Hugo supported folder structure, our COLONY Framework stylesheets,
commonly used
All included files are pre-linked so they are ready to use with no futher configuration.
Video Overview
Directory Folders
An overview of the folders within our standard structure, their usage and the pre-loaded files they contain. Any items not mentioned explicitly are assumed to be as default in the standard COLONY template.
Used to set templates for the Front Matter of content pages. Included as part of the standard Hugo file structure but not currently configured by COLONY.
Archetypes
default.md Controls the default configuration of Front Matter for content pages.
Used to store items intended for usage as Resources by Hugo. Assets stored here can support advanced features such as automated image resizing. Included as part of the standard Hugo file structure but not currently configured by COLONY.
*Please note this is not the location to store standard images & assets - these should be added to Static unless otherwise instructed.
Assets
optimised images Storage of images intended for Hugo resizing.
index.md Blank file to ensure folder is tracked by Git. No function.
Used to store frontend content pages in the form of HTML and Markdown files. This folder will contain all webpages in a project (with the exception of the website homepage).
Content
example.html Blank html file to demonstrate the standard Front Matter.
Used to store data and configuration files that can be utilised by Hugo when generating the website. A good summary of the usage of the usage of data files can be found in this YouTube Video.
Multiple files types are supported by Hugo but only .json are currently utilised by COLONY.
Data
configComponents.json Controls the visibility of pre-loaded components such as notifications & popups.
configScripts.json Controls the scripts that are loaded when the site is compiled.
Auto-generated by some Hugo processes to store assets. This folder is not used by COLONY during development.
Used to store templates in the form of .html files to specify how different content will be rendered. A good summary of the usage of the usage of the layouts folder can be found in videos 12-15 of this YouTube Playlist.
For COLONY sites this folder controls the Homepage, Headers, Footers, HTML head tag & common scripts as standard.
Learn more about the Layouts folderLayouts
index.html The homepage of the website.
_default Folder defining the base page structure as well as the default layout for List & Single pages.
baseof.html Configuration of base page structure for the project.
list.html Configuration of default List pages in the project.
single.html Configuration of default Single pages in the project.
partials Storage of Partial templates, html snippets that are injected into all pages by default.
custom Storage of additional project specific partials created during development.
components.html Contains pre-loaded base components for the website.
footer.html Defines the html for the website footer.
head.html Defines the html for the website head tag.
header.html Defines the html for the website header, navigation & menu.
scripts.html Defines commonly used scripts and links.
shortcodes Used for Shortcode templates. Re-usable snippets that can be added inside content pages.
index.md Blank file to ensure folder is tracked by Git. No function.
Used to store all website assets that are served without modification. Assets such as images, videos, CSS, Javascript, fonts & other static files will all be saved here in dedicated sub-folders.
Learn more about the Static folderStatic
robots.txt Configuration file determining how the website is presented to search engines.
index.html Configuration file determining URL redirections.
admin Contains the configuration files for Netlify CMS. Amendment to these files is not required during a standard build.
config.yml Configuration file controlling the Netlify CMS admin portal.
index.html Configuration file controlling the Netlify CMS admin portal.
assets Stores all standard website assets (each within their own sub-folder).
css Stores COLONY Framework, Components, third-party & custom css stylesheets.
files Stores document files such as PDF's used by the project.
fonts Stores all font files used by the project.
img Stores all images used by the project.
js Stores COLONY Components, third-party & custom Javascript.
videos Stores all videos used by the project.
Misceleneous files stored at the top level of the directory structure.
config.toml Configuration file that defines basic project settings such as the baseURL & Site Name.
netlify.toml Configuration file that defines the build settings for our hosting platform Netlify.