View Source SemanticMarkdown.Type (semantic_markdown v0.1.0)
SemanticMarkdown.Type
is a module containing used types within
SemanticMarkdown
Link to this section Summary
Link to this section Types
@type ast() :: Earmark.ast()
@type ast_tuple() :: Earmark.ast_tuple()
@type content() :: content_map() | String.t() | boolean()
@type options() :: [option()]
Keyword list of options.
Available options:
own
Own
footnotes_see
- Title of footnote link (default:"see footnote"
), see Foonotes Rationalefootnotes_return
- Same as above but for the return link (default:"return to article"
)clean_newlines
- By default Markdown outputs nice parse such as:<p>\ncontent\n</p>
. This setting cleans it out (default:true
)earmark_inner_transform
- whether parsed inner tags should be re-parsed once more as Markdown (default:true
)content_tag_name
- name of the default content, i.e. not marked by any semantic tags (default:"content"
)merge_content
- whether to merge non-tagged nodes and put it as a final "content" node (default:false
)
earmark-s
Earmark
's
footnotes
- whetherEarmark
should parse footnotes (default:true
)earmark_transform_options
- options passed directly toEarmark.transform
(default:%{}
)
Keyword list containing Markdown transformed into HTML.
Minimal result is [content: String.t]
representing parsed input string,
where content key is configurable.
Parsed semantic tags can be either in form of:
{tag_name :: atom(), tag_content :: String.t}
{tag_name :: atom(), tag :: [semantic_tag]}
There are 2 special keys:
content
that contains parsed markdown contentattributes
that contains XML tag attributes