Skip to content

Commit

Permalink
update page docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kjaymiller committed Aug 15, 2019
1 parent 082ce13 commit a25931c
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/page.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
Title: Page Object
# Page Object

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

### Page.slug
## Page.slug
The stem of the URL that relates to this Page's file.

### Page.content
## Page.content
This is the raw content of the file. Currently _HTML_ and _Markdown_ are to supported.

### Page.markup
## Page.markup
This is content that is converted to html and [marked up](#) for a template engine to parse.

TODO: Add support for RST

### Page.content_from_file
## Page.content_from_file
Alternatively, you can specify a filepath that uses an [RST-Like Metadata system](#) to identify attributes for the page object.

This is great for building dynamic pages without cluttering up your [engine runner](#).
Expand All @@ -23,10 +23,10 @@ Other attributes that extend the functionality of Page objects. This is great wh

This can be also be used with creating pages that support the display of [Collections][collections].

Common Additional Attrs Include:
**Common Additional Attrs Include:**

* `date_published`
* `date_modified'
* `date_modified`
* `author`
* `link`
* `media`
Expand All @@ -35,6 +35,6 @@ Common Additional Attrs Include:

Additional Attrs can be of _any_ type.

### Page.template
## Page.template
If your page uses a template file (render_engine supports [Jinja2](https://palletsprojects.com/p/jinja/) out of the box) then you can specify your template file and render engine will use that to build out your page. It will use any standard or additional attrs as template markup variables by default. No more manually telling it what to use.

0 comments on commit a25931c

Please sign in to comment.