Packages

mdex

0.5.0
0.13.4 0.13.3 0.13.2 0.13.1 0.13.0 0.12.5 retired 0.12.4 0.12.3 0.12.2 0.12.1 0.12.0 0.11.7 0.11.6 0.11.5 0.11.4 0.11.3 0.11.2 0.11.1 0.11.0 0.10.0 0.9.4 0.9.3 0.9.2 0.9.1 0.9.0 0.8.6 0.8.5 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.5 0.7.4 0.7.3 0.7.2 0.7.1 0.7.0 0.6.2 0.6.1 0.6.0 0.5.0 0.4.3 0.4.2 0.4.1 0.4.0 0.3.3 0.3.2 0.3.1 0.3.0 0.2.0 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

Fast and extensible Markdown for Elixir

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
70 Versions
4 Dependencies
36 Dependants
6 Advisories
Files
Activity
mdex examples README.md
Raw

examples/README.md 

## Examples



Currently all examples depend on unrelead code present only in the `main` branch,

to execute it will need Rust installed to compile the dependencies.



### Liquid



Render [Liquid Tags](https://shopify.github.io/liquid/)



```sh

elixir liquid.exs && open liquid.html

```



## Mermaid



Render [Mermaid Diagrams](https://mermaid-js.github.io/mermaid/)



```sh

elixir mermaid.exs && open mermaid.html

```



## Alerts



Render [GitHub Alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)



```sh

elixir alerts.exs && open alerts.html

```



## Highlight



Render `==` as `<mark>` tags as described at https://www.markdownguide.org/extended-syntax/#highlight



```sh

elixir highlight.exs && open highlight.html

```



## HEEx



Render Markdown with HEEx syntax and Phoenix Components



```sh

elixir heex.exs && open heex.html

```



## LiveView



Convert markdown to a LiveView HEEx template supporting Phoenix components.



Inspired by https://twitter.com/pepicrft/status/1714694213642637538



```sh

iex live_view.exs

```



To replicate this example in a real application, copy the `MDEx.LiveView` module into your application,

then import it in your LiveView or in your application `Web` module (see `DemoLive` in the example).



Note that you can change the options passed to `MDEx.to_html!/2` in the `sigil_M` macro.



## NimblePublisher + LiveView



Build your blog posts using the [NimblePublisher](https://github.com/dashbitco/nimble_publisher) library and serve them with LiveView.



```sh

iex nimble_publisher.exs

```



Open [localhost:4000](http://localhost:4000) to view the rendered blog post.