tableau

defmodule Tableau do
  @moduledoc """
  ## 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`. See `MDEx` documentation for list of options, as options listed here are non-standard and specific to Tableau.
          * `:plugins` - module list - MDEx plugin modules to attach to the processing pipeline
  * `:slug` - keyword - Options to pass to `Slug.slugify/2`

  ### Example

  ```elixir
  # config/config.exs

  import Config

  config :tableau, :config,
    url: "http://localhost:8080",
    timezone: "America/Indiana/Indianapolis",
    converters: [
      md: Tableau.MDExConverter,
      dj: MySite.DjotConverter
    ],
    slug: [
      lowercase: false
    ],
    markdown: [
      mdex: [
        extension: [
          table: true,
          header_ids: "",
          tasklist: true,
          strikethrough: true,
          autolink: true,
          alerts: true,
          footnotes: true
        ],
        render: [unsafe: true],
        syntax_highlight: [formatter: {:html_inline, theme: "neovim_dark"}],
        plugins: [MDExGFM]
      ]
    ]
  ```
  """

  @doc """
  Component to connect to the development server via websocket to broadcast that the page should reload.

  By default, connects to `'ws://' + location.host + '/ws'`.

  See `WebDevUtils.Components.live_reload/1` for configuration options.
  """
  defdelegate live_reload(assigns), to: WebDevUtils.Components

  @doc """
  Convert markdown content to HTML using `MDEx.to_html!/2`.

  Will use the globally configured options, but you can also pass it overrides.
  """
  defdelegate markdown(content, overrides \\ []), to: Tableau.MDExConverter
end