API Reference tableau v0.24.0

Modules

Global Site Configuration

:include_dir - string - Directory that is just copied to the output directory. Defaults to extra.
:out_dir - string - The directory to output your website to. Defaults to _site.
:timezone - string - Timezone to use when parsing date times. Defaults to Etc/UTC.
:base_path - string - Development server root. Defaults to '/'.
:url - string (required) - The URL of your website.
:converters - mapping of file extensions to converter module. Defaults to [md: Tableau.MDExConverter]
:markdown - keyword
- :mdex - keyword - Options to pass to MDEx.to_html/2

Example

# configs/config.exs
config :tableau, :config,
  url: "http://localhost:8080",
  timezone: "America/Indiana/Indianapolis",
  converters: [
    md: Tableau.MDExConverter,
    dj: MySite.DjotConverter
  ],
  markdown: [
    mdex: [
      extension: [table: true, header_ids: "", tasklist: true, strikethrough: true],
      render: [unsafe_: true],
      features: [syntax_highlight_theme: "kanagawa"]
    ]
  ]

Tableau.Converter

Defines the interface for the converter module used by extensions to parse markup files.

Tableau.DataExtension

YAML files and Elixir scripts (.exs) in the configured directory will be automatically parsed/executed and made available in an @data assign in your templates.

Tableau.Document.Helper

Helper functions for Tableau documents.

Tableau.Extension

A tableau extension.

Tableau.Layout

A tableau layout.

Tableau.MDExConverter

Converter to parse markdown content with MDEx

Tableau.Page

A tableau page.

Tableau.PageExtension

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