v0.2.0

CHANGELOG.md

@@ -1,21 +1,25 @@
 # Changelog
 
-## 0.2.0-dev
+## 0.2.0 (2024-10-09)
+
+### Breaking changes
+  * `to_html/1` and `to_html/2` now returns `{:ok, String.t()}` or `{:error, %MDEx.DecodeError{}}` instead of just `String.t()`.
+    The reason is because now they may accept an AST as input which may cause decoding errors.
+    Replace with `to_html!/1` and `to_html!/2` to have the same behavior as before.
+
+### Fixes
+  * Fix misspelling of `thematic` causing render errors - [#73](https://github.com/leandrocp/mdex/pull/73) by @jonklein
 
 ### Enhancements
   * Added `to_commonmark/1` and `to_commonmark/2` to convert an AST to CommonMark - [#70](https://github.com/leandrocp/mdex/pull/70) by @jonklein
-  * Added `~M` sigil with `a` (AST) modifier (defaults to HTML without the modifier)
+  * Added `~M` sigil (no interpolation) with `AST` and `MD` modifiers (defaults to HTML without the modifier)
+  * Added `~m` sigil (supports interpolation and escaping) with `AST` and `MD` modifiers (defaults to HTML without the modifier)
   * Added `parse_document/1` and `parse_document/2` to parse Markdown to AST
-  * Added `traverse_and_update/2` and `attribute/2` to manipulate AST
-  * Added `to_html!/1` and `to_html!/2`
+  * Added low-level functions `traverse_and_update/2` and `attribute/2` to manipulate AST
+  * Added `to_html!/1` and `to_html!/2`, the raising version of `to_html/1` and `to_html/2` (similar to previous `to_html/1` and `to_html/2`)
   * Changed `to_html/1` and `to_html/2` to accept AST as input
   * Added examples directory to show how to use the new APIs
 
-### Breaking changes
-  * `to_html/1` and `to_html/2` now returns `{:ok, String.t()}` or `{:error, %MDEx.DecodeError{}}` instead of just `String.t()`
-    The reason is because now they may accept an AST as input which may cause decoding errors.
-    Replace with `to_html!/1` and `to_html!/2` to have a similar behavior as before.
-
 ## 0.1.18 (2024-07-13)
 
 ### Enhancements

README.md

@@ -44,15 +44,15 @@ Add `:mdex` dependency:
 ```elixir
 def deps do
   [
-    {:mdex, "~> 0.1"}
+    {:mdex, "~> 0.2"}
   ]
 end
 ```
 
 ## Usage
 
 ```elixir
-Mix.install([{:mdex, "~> 0.1"}])
+Mix.install([{:mdex, "~> 0.2"}])
 ```
 
 ```elixir

mix.exs

@@ -2,7 +2,7 @@ defmodule MDEx.MixProject do
   use Mix.Project
 
   @source_url "https://github.com/leandrocp/mdex"
-  @version "0.2.0-dev"
+  @version "0.2.0"
   @dev? String.ends_with?(@version, "-dev")
   @force_build? System.get_env("MDEX_BUILD") in ["1", "true"]