Last active
February 3, 2019 22:01
-
-
Save funkybob/5bceb85ddef4db3fe2bebbc69c69829a to your computer and use it in GitHub Desktop.
gilbert - an overview
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A gilbert project is a directory with 5 sub directories: | |
- static/ | |
- pages/ | |
- content/ | |
- templates/ | |
- dest/ | |
Upon calling render, the site will: | |
- create an index of files in static; only referenced files will be copied to the destination | |
- build a Collection of objects from `content`. | |
- build a Collection of objects from `pages`. | |
- render the pages to the destination | |
Content Objects are YAML files containing descriptions of different content types. | |
They may contain multiple documents. | |
The `content_type` key of the YAML document names the class to use. | |
The system can be extended with many conten types. | |
The only difference between the `pages` collection and the `content` collection is `pages` will be rendered directly; other content objects are available for use across pages. | |
# Content Types | |
DataObject | |
Simply contains data from the YAML file - nothing more. | |
Page | |
- Has a specified `template` | |
? can 'gather' other content? might require a query syntax... | |
ScssDocument | |
- Content is SCSS and will be rendered to a .css file |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment