README.adoc

= Asciidoctor

The final goal is to implement a full AsciiDoctor toolchain in Elixir.

.For now it implements a few basic things like
* Reading of document attributes
* Executing the real asciidoctor command to convert an asciidoctor file to html/pdf

== Installation

First install asciidoctor.
[source, bash]
----
sudo apt install asciidoctor
----
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `asciidoctor` to your list of dependencies in `mix.exs`:

[source,elixir]
----
def deps do
  [
    {:asciidoctor, "~> 0.1.0"}
  ]
end
----

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/asciidoctor](https://hexdocs.pm/asciidoctor).