---
is the most common usage, but you can also use ###
or whatever repeats 3 or more times. By default, we parse the meta data with YAML but you can also use CSON by doing --- cson
instead.layouts
folder. Layout files can use other layouts for advanced layout nesting.filename
. The name of the document. Useful for listings.mtime
. Useful for setting a custom date via your documents meta data.relativeBase
. Appears deprecated in favour of url
.false
. If set to true
, the document will not be parsed. Useful for draft documents.false
. If set to true
, when a change is detected for the document, we will only regenerate this document and not anything else (e.g., documents with referencesOthers
set to true
).false
. If set to true
, this document will be regenerated when a change occurs in another document. It is automatically set to true
whenever a template helper is called that references another document. This makes so for instance on a blog listing page, when a blog post is changed, we will also regenerate the listing as well as the blog post.[]
. Tags can be a comma separated values list, or an array of values. While DocPad doesn't use tags for anything specifically, it is nice to have it handled uniformly across websites without you having to do it yourself.false
. If set to true
, the document will be re-rendered on each request. This also adds the req
object to the template data.relativePath
, we set the id
to that instead.eco
for the file hello.md.eco
).extension
however it takes layouts into account as well.["md","eco"]
for the file hello.md.eco
).Date
object for when this file was created.Date
object for when this file was modified.binary
or utf8
.encoding
isn't binary
, this is set to the raw contents of the file, stored as a string.encoding
isn't binary
, this is set to the contents of the file, stored as a string. This is used internally during the rendering process, end-users should never use this property, instead they should either source
or contentRendered
depending on the use case.true
. Whether or not this document should be written to the output directory.true
. Whether or not this document should be rendered.yaml
. The parser we used to parse the document's meta data header.false
. Set to true
once we have been rendered.toJSON
on the original meta data to meta
within the result.referencesOthers
flag.