DprintMarkdownFormatter.Sigil (dprint_markdown_formatter v0.3.0)
View SourceProvides the ~M sigil for embedding markdown content in Elixir code.
The ~M sigil creates markdown strings that can be used directly in your application without any additional processing.
Usage
import DprintMarkdownFormatter.Sigil
# Simple markdown
title = ~M"# Welcome to My App"
# Multi-line markdown with code blocks
docs = ~M"""
# API Documentation
## Authentication
```elixir
defmodule MyApp.Auth do
def authenticate(token) do
# Implementation here
end
end
```
## Usage
Call the authenticate function with your token.
"""
Modifiers
The ~M sigil ignores all modifiers and always returns the raw markdown string.
Summary
Functions
Creates a markdown string from the given content.
Functions
Creates a markdown string from the given content.
The ~M sigil creates a raw markdown string that can be formatted by mix format
when the DprintMarkdownFormatter plugin is configured.
Examples
iex> import DprintMarkdownFormatter.Sigil
iex> ~M"# Hello World"
"# Hello World"
iex> import DprintMarkdownFormatter.Sigil
iex> ~M"**Bold** and *italic* text"
"**Bold** and *italic* text"
iex> import DprintMarkdownFormatter.Sigil
iex> ~M"""
...> # Title
...>
...> Content here.
...> """
"# Title\n\nContent here.\n"