View Source Tableau.PostExtension (tableau v0.7.0)

Markdown files (with YAML frontmatter) in the configured posts directory will be automatically compiled into Tableau pages.

Certain frontmatter keys are required and all keys are passed as options to the Tableau.Page.

options

Options

Frontmatter is compiled with yaml_elixir and supports atom keys by prefixing a key with a colon :title:. Certain required keys must be presented as atoms, but all user provided keys may be string or atom keys.

  • :id - An Elixir module to be used when compiling the backing Tableau.Page
  • :title - The title of the post
  • :permalink - The permalink of the post. :title will be replaced with the posts title and non alphanumeric characters removed
  • :date - An Elixir NaiveDateTime, often presented as a sigil_N
  • :layout - A Tableau layout module.

example

Example

---
:id: "Update.Volume3"
:title: "The elixir-tools Update Vol. 3"
:permalink: "/news/:title"
:date: "~N[2023-09-19 01:00:00]"
:layout: "ElixirTools.PostLayout"
---

Link to this section Summary

Functions

Callback implementation for Tableau.Extension.run/1.

Link to this section Functions

Callback implementation for Tableau.Extension.run/1.