Packages

mq_elixir

0.1.10
0.1.24 0.1.23 0.1.22 0.1.21 0.1.20 0.1.19 0.1.18 0.1.17 0.1.16 0.1.15 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Elixir bindings for mq, a jq-like command-line tool for Markdown processing. Process markdown, MDX, HTML, and plain text using the mq query language.

HexDocs

Current section

Files

Jump to
Readme
25 Versions
1 Dependency
Dependants
Files
Activity
mq_elixir lib mq conversion_options.ex
Raw

lib/mq/conversion_options.ex 

defmodule Mq.ConversionOptions do

  @moduledoc """

  Options for HTML to Markdown conversion.



  ## Fields



  - `:extract_scripts_as_code_blocks` - Extract `<script>` tags as code blocks

  - `:generate_front_matter` - Generate YAML front matter from meta tags

  - `:use_title_as_h1` - Use `<title>` tag as H1 heading

  """



  @type t :: %__MODULE__{

          extract_scripts_as_code_blocks: boolean(),

          generate_front_matter: boolean(),

          use_title_as_h1: boolean()

        }



  defstruct extract_scripts_as_code_blocks: false,

            generate_front_matter: false,

            use_title_as_h1: false



  @doc """

  Convert ConversionOptions struct to a map for passing to NIF.

  """

  @spec to_map(t()) :: map()

  def to_map(%__MODULE__{} = opts) do

    Map.from_struct(opts)

  end

end