From 185274bbf889ab5a5caaa78296cbf3dba4e0c31f Mon Sep 17 00:00:00 2001 From: pnezis Date: Mon, 2 Oct 2023 20:39:02 +0300 Subject: [PATCH] Release v0.3.0 --- CHANGELOG.md | 14 +++++++++++--- README.md | 16 +++++++++------- mix.exs | 3 ++- 3 files changed, 22 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 991c5f6..da32e19 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,17 @@ # Changelog -## [UNRELEASED] +## [v0.3.0](https://github.com/pnezis/fancy_fences/tree/v0.3.0) (2023-10-02) +### Added + +- Add some default fence processors under `FancyFences.Processors` +- Update documentation + +### Fixed + +- Apply fence processors recursively under any HTML AST element. -## [v0.2.0] (2023-08-09) +## [v0.2.0](https://github.com/pnezis/fancy_fences/tree/v0.2.0) (2023-08-09) ### Added @@ -11,6 +19,6 @@ ### Fixed -## [v0.1.0] (2023-06-20) +## [v0.1.0](https://github.com/pnezis/fancy_fences/tree/v0.1.0) (2023-06-20) Initial release. diff --git a/README.md b/README.md index 4ccd2d9..c0924fc 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,15 @@ [![Documentation](https://img.shields.io/badge/-Documentation-blueviolet)](https://hexdocs.pm/fancy_fences) `FancyFences` is a markdown processor on top of [`EarmarkParser`](https://github.com/pragdave/earmark) -(the default markdown processor used by [`ExDoc`](https://github.com/elixir-lang/ex_doc). You can -use it to conditionally post-process code blocks allowing you to: +(the default markdown processor used by [`ExDoc`](https://github.com/elixir-lang/ex_doc). +You can use it to conditionally post-process code blocks allowing you to: - Ensure that the code examples are valid - Format code blocks -- Evaluate code blocks and include the output in the documenation, for example you can: - - add the `inspect` ouptut of a code block in order to have up to date code samples in your docs +- Evaluate code blocks and include the output in the documenation, for example +you can: + - add the `inspect` ouptut of a code block in order to have up to date code + samples in your docs - auto-generate vega-lite or mermaid plots - use it instead of interplation for evaluating functions within the current module. @@ -82,7 +84,7 @@ In order to install the package add the following to your `mix.exs`: ```elixir def deps do [ - {:fancy_fences, "~> 0.2.0", only: :dev, runtime: false} + {:fancy_fences, "~> 0.3.0", only: :dev, runtime: false} ] end ``` @@ -93,5 +95,5 @@ and configure your fence processors accoring to the [docs](https://hexdocs.pm/fa Copyright (c) 2023 Panagiotis Nezis -Tucan is released under the MIT License. See the [LICENSE](LICENSE) file for more -details. +`fancy_fences` is released under the MIT License. See the [LICENSE](LICENSE) file +for more details. diff --git a/mix.exs b/mix.exs index 86521ae..f4b4e90 100644 --- a/mix.exs +++ b/mix.exs @@ -2,7 +2,7 @@ defmodule FancyFences.MixProject do use Mix.Project @scm_url "https://github.com/pnezis/fancy_fences" - @version "0.2.0" + @version "0.3.0" def project do [ @@ -45,6 +45,7 @@ defmodule FancyFences.MixProject do defp docs do [ + main: "readme", canonical: "http://hexdocs.pm/fancy_fences", source_url_pattern: "#{@scm_url}/blob/v#{@version}/%{path}#L%{line}", skip_undefined_reference_warnings_on: ["CHANGELOG.md"],