MDEx
▼
Project version
v0.5.0
v0.4.3
v0.4.2
v0.4.1
v0.4.0
v0.3.3
v0.3.2
v0.3.1
v0.3.0
v0.2.0
v0.1.18
v0.1.17
v0.1.16
v0.1.15
v0.1.14
v0.1.13
v0.1.12
v0.1.11
v0.1.10
v0.1.9
v0.1.8
v0.1.7
v0.1.6
v0.1.5
v0.1.4
v0.1.3
v0.1.2
v0.1.1
v0.1.0
Pages
Modules
API Reference
Modules
Changelog
0.5.0 (2025-03-31)
0.4.3 (2025-03-29)
0.4.2 (2025-03-25)
0.4.1 (2025-03-24)
0.4.0 (2025-03-10)
0.3.3 (2025-02-03)
0.3.2 (2025-01-11)
0.3.1 (2025-01-08)
0.3.0 (2024-12-16)
0.2.0 (2024-10-09)
0.1.18 (2024-07-13)
0.1.17 (2024-06-19)
0.1.16 (2024-04-29)
0.1.15 (2024-04-16)
0.1.14 (2024-04-11)
0.1.13 (2023-11-20)
0.1.12 (2023-11-06)
0.1.11 (2023-10-25)
0.1.10 (2023-10-24)
0.1.9 (2023-09-29)
0.1.8 (2023-09-29)
0.1.7 (2023-09-27)
0.1.6 (2023-09-14)
0.1.5 (2023-09-12)
0.1.4 (2023-09-11)
0.1.3 (2023-09-11)
0.1.2 (2023-09-11)
0.1.1 (2023-09-11)
0.1.0 (2023-09-11)
MDEx
Sections
Features
Installation
Usage
Req-like Pipeline
Sigils
Safety
Parsing
Formatting
Examples
Pre-compilation
Demo and Samples
Used By
Benchmark
Motivation
Looking for help with your Elixir project?
Acknowledgements
Summary
Types
extension_options/0
features_options/0
options/0
parse_options/0
parse_source/0
render_options/0
sanitize_options/0
source/0
Functions
default_extension_options/0
default_features_options/0
default_parse_options/0
default_render_options/0
default_sanitize_options/0
new/1
parse_document/2
parse_document!/2
parse_fragment/2
parse_fragment!/2
safe_html/2
to_commonmark/1
to_commonmark/2
to_commonmark!/1
to_commonmark!/2
to_html/1
to_html/2
to_html!/1
to_html!/2
to_json/1
to_json/2
to_json!/1
to_json!/2
to_markdown/1
to_markdown/2
to_markdown!/1
to_markdown!/2
to_xml/1
to_xml/2
to_xml!/1
to_xml!/2
traverse_and_update/2
traverse_and_update/3
MDEx.Document
Sections
String.Chars
Access
Enumerable
Traverse and Update
Examples
Summary
Types
md_node/0
selector/0
t/0
Functions
fetch/2
get_and_update/3
pop/3
wrap/1
MDEx.Pipe
Sections
Writing Plugins
Summary
Types
step/0
t/0
Functions
append_steps/2
get_option/3
get_private/3
halt/1
halt/2
prepend_steps/2
put_extension_options/2
put_features_options/2
put_node_in_document_root/3
put_options/2
put_parse_options/2
put_private/3
put_render_options/2
register_options/2
run/1
update_nodes/3
update_private/4
MDEx.Sigil
Sections
Modifiers
Options
Summary
Functions
sigil_M/2
sigil_m/2
Document Nodes
MDEx.Alert
Summary
Types
t/0
MDEx.BlockQuote
Summary
Types
t/0
MDEx.Code
Summary
Types
t/0
MDEx.CodeBlock
Summary
Types
t/0
MDEx.DescriptionDetails
Summary
Types
t/0
MDEx.DescriptionItem
Summary
Types
t/0
MDEx.DescriptionList
Summary
Types
t/0
MDEx.DescriptionTerm
Summary
Types
t/0
MDEx.Emph
Summary
Types
t/0
MDEx.Escaped
Summary
Types
t/0
MDEx.EscapedTag
Summary
Types
t/0
MDEx.FootnoteDefinition
Summary
Types
t/0
MDEx.FootnoteReference
Summary
Types
t/0
MDEx.FrontMatter
Summary
Types
t/0
MDEx.Heading
Summary
Types
t/0
MDEx.HtmlBlock
Summary
Types
t/0
MDEx.HtmlInline
Summary
Types
t/0
MDEx.Image
Summary
Types
t/0
MDEx.LineBreak
Summary
Types
t/0
MDEx.Link
Summary
Types
t/0
MDEx.List
Summary
Types
t/0
MDEx.ListItem
Summary
Types
t/0
MDEx.Math
Summary
Types
t/0
MDEx.MultilineBlockQuote
Summary
Types
t/0
MDEx.Paragraph
Summary
Types
t/0
MDEx.Raw
Summary
Types
t/0
MDEx.ShortCode
Summary
Types
t/0
MDEx.SoftBreak
Summary
Types
t/0
MDEx.SpoileredText
Summary
Types
t/0
MDEx.Strikethrough
Summary
Types
t/0
MDEx.Strong
Summary
Types
t/0
MDEx.Subscript
Summary
Types
t/0
MDEx.Superscript
Summary
Types
t/0
MDEx.Table
Summary
Types
t/0
MDEx.TableCell
Summary
Types
t/0
MDEx.TableRow
Summary
Types
t/0
MDEx.TaskItem
Summary
Types
t/0
MDEx.Text
Summary
Types
t/0
MDEx.ThematicBreak
Summary
Types
t/0
MDEx.Underline
Summary
Types
t/0
MDEx.WikiLink
Summary
Types
t/0
Exceptions
MDEx.DecodeError
Summary
Types
t/0
Functions
message/1
MDEx.InvalidInputError
Summary
Types
t/0
Functions
message/1
MDEx.InvalidSelector
Summary
Types
t/0
Functions
message/1
Search documentation of MDEx
Settings
MDEx.DescriptionList
(MDEx v0.5.0)
View Source
A description list.
Summary
Types
t()
Types
t()
@type
t() :: %MDEx.DescriptionList{nodes: [
MDEx.Document.md_node
()]}