Documentation Pages
Using Data #
Data can be used on a template from multiple different sources.
Sources of Data #
The order of priority for sources of data is (from highest priority to lowest):
- Front Matter Data in a Template
- Front Matter Data in Layouts
- Template Data Files
- Directory Data Files (and ascending Parent Directories)
- Global Data Files
Eleventy Provided Data Variables #
Here are a few data values we supply to your page that you can use in your templates:
pkg
: The local project’spackage.json
values.pagination
, when enabled using pagination in front matter. Read more about Pagination.collections
: Lists of all of your content, grouped by tags. Read more about Collectionspage
: Has information about the current page. See code block below forpage
contents. For example,page.url
is useful for finding the current page in a collection. Read more about Collections (look at Example: Navigation Links with anactive
class added for on the current page).
page
Variable Contents: #
let page = {
// URL can be used in <a href> to link to other templates
url: "/current/page/myFile/",
// Mapped from inputPath, useful for permalinks (New in v0.3.4)
fileSlug: "myFile",
// JS Date Object for current page (used to sort collections)
date: new Date(),
// The path to the original source file for the template
// Note: this will include your input directory path!
inputPath: "./current/page/myFile.md",
// Depends on your output directory (the default is _site)
// You probably won’t use this: `url` is better.
outputPath: "./_site/current/page/myFile/index.html"
};
fileSlug
New in v0.3.4 #
The fileSlug
variable is mapped from inputPath and is useful for creating your own clean permalinks.
inputPath | Resulting fileSlug |
---|---|
"2018-01-01-myFile.md" | "myFile" |
"myDir/myFile.md" | "myFile" |
fileSlug
returns information on the parent directory if the file is an index
template:
inputPath | Resulting fileSlug |
---|---|
"index.md" | "" (empty) |
"myDir/index.md" | "myDir" |
"myDir/2018-01-01-index.md" | "myDir" |
date
#
The date associated with the page. Defaults to the content’s file created date but can be overridden. Read more at Content Dates.