Skip to content

Commit

Permalink
add collection.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kjaymiller committed Aug 20, 2019
1 parent a7286ac commit 8733d22
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
26 changes: 26 additions & 0 deletions docs/collection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Collection Objects

A collection object is a group of pages that share a root path and other attributes.

## Collection.slug
The root path of all items in the collection.

## Collection.content_from_path
A path you can use to load a set of Pages (loaded using [content_from_file])

## Collection.pages
The building blocks of collections. This is an iterable of [Page] objects.

## Additional Collection Attrs
Collection Attrs are similar to page attrs except they are passed to ALL PAGES IN THE COLLECTION

Additional attrs can be _anything_ but common attrs include:

* Author
* Category
* tags
* Link
* Intro
* Content Footer


2 changes: 1 addition & 1 deletion docs/page.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Page Object
# Page Objects

The Page Object is the basic building block for all objects. Essentially your site is built from one or many Page objects.

Expand Down

0 comments on commit 8733d22

Please sign in to comment.