Skip to content

Commit

Permalink
Release v0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
pnezis committed Oct 2, 2023
1 parent dcea69a commit 185274b
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 11 deletions.
14 changes: 11 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
# 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

- Support fancy fences in blockquotes

### 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.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
```
Expand All @@ -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.
3 changes: 2 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -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
[
Expand Down Expand Up @@ -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"],
Expand Down

0 comments on commit 185274b

Please sign in to comment.