Skip to content

Latest commit

 

History

History
104 lines (95 loc) · 6.13 KB

README.md

File metadata and controls

104 lines (95 loc) · 6.13 KB
Raw

Reference documentation

Core structure

Features

  • aliases: Build redirection pages for page aliases.
  • data: Handle datasets in content directories.
  • dirindex: Build redirection pages for page aliases.
  • images: Handle images in content directory.
  • jinja2: Render jinja2 templates from the contents directory.
  • links: Collect links and link metadata from page metadata.
  • md: Render .md markdown pages, with front matter.
  • nav: Expand a 'pages' metadata containing a page filter into a list of pages.
  • rst: Render .rst reStructuredText pages, with front matter.
  • syndication: Build syndication feeds for groups of pages.
  • taxonomy: Tag pages using one or more taxonomies.

Page types

  • alias: Page rendering a redirect to another page
  • archive: An archive page is automatically created for each syndication.
  • asset: A static asset, copied as is
  • atom: An Atom syndication page
  • category: Index page showing all the pages tagged with a given taxonomy item
  • data: Data files
  • dir: Page with a directory index.
  • image: An image as found in the source directory
  • jinja2: Jinja2 pages
  • links: Page with a link collection posted as metadata only.
  • links_index: Root page for the browseable archive of annotated external links in the site
  • markdown: Markdown sources
  • rss: A RSS syndication page
  • rst: RestructuredText files
  • scaledimage: Scaled version of an image
  • taxonomy: Root page for one taxonomy defined in the site

Page fields

  • aliases: Relative paths in the destination directory where the page should also show up. Like in Hugo, this can be used to maintain existing links when moving a page to a different location.
  • asset: If set to True for a file (for example, by a file: pattern in a directory index), the file is loaded as a static asset, regardless of whether a feature would load it.
  • author: A string with the name of the author for this page.
  • copyright: Copyright notice for the page. If missing, it's generated using template_copyright.
  • created_from: Page that generated this page.
  • data_type: Type of data for this file.
  • date: Publication date for the page.
  • description: The page description. If omitted, the page will have no description.
  • draft: If true, the page is still a draft and will not appear in the destination site, unless draft mode is enabled.
  • front_matter: Front matter as parsed by the source file
  • height: Image height
  • image: Image used for this post.
  • image_orientation: Image orientation
  • index: Page that defined the syndication for this feed
  • indexed: If true, the page appears in directory indices and in page filter results.
  • lat: Image latitude
  • links: Extra metadata for external links.
  • lon: Image longitude
  • name: Name of the category shown in this page
  • nav: List of page paths, relative to the page defining the nav element, that are used for the navbar.
  • nav_title: Title to use when this page is linked in a navbar.
  • page: Page this alias redirects to
  • pages: The pages metadata can use to select a set of pages shown by the current page. Although default page.html template will not do anything with them, other page templates, like blog.html, use this to select the pages to show.
  • parent: Page one level above in the site hierarchy
  • related: Readonly mapping of pages related to this page, indexed by name.
  • series: List of categories for the series taxonomy.
  • series_title: Series title from this page onwards.
  • site_name: Name of the site. If missing, it defaults to the title of the toplevel index page. If missing, it defaults to the name of the content directory.
  • site_url: Base URL for the site, used to generate an absolute URL to the page.
  • syndicated: Set to true if the page can be included in a syndication, else to false.
  • syndication: Defines syndication for the contents of this page.
  • syndication_date: Syndication date for this page.
  • tags: List of categories for the tags taxonomy.
  • taxonomy: Structured taxonomy information
  • template: Template used to render the page. Defaults to page.html, although specific pages of some features can default to other template names.
  • template_copyright: jinja2 template to use to generate copyright when it is not explicitly set.
  • template_description: jinja2 template to use to generate description when it is not explicitly set.
  • template_title: jinja2 template to use to generate title when it is not explicitly set.
  • title: Page title.
  • width: Image width

Back to README