ExDocDash

Creates API documentation for Elxir projects in the Docsets format for use in Dash.app for MacOS X or iOS. This is the first draft so problems may occur.

Template Design is generated using Fez Vrasta's Bootstap Material Design framework

Installation & Usage

Open up your mix.exs and add the following to your deps. For reasons I have not yet found out mix will sometimes not grab the sqlite3 dep from the project so you have to require it from the using library for now.

{:sqlite3, ">= 1.0.1", github: "sergey-miryanov/erlang-sqlite3", only: :docs},
{:ex_doc_dash, "~> 0.1.0", only: :docs}

Build your dependencies

MIX_ENV=docs mix do deps.get, deps.compile

Now you can build your Dash.app documentation using the docs.dash task and it will be save in ./docs.

MIX_ENV=docs mix docs.dash

Example of generating Phoenix Documentation

ExDocDash Phoenix docs

Contributing

All contributions are appreciated. Info on the Docset format can be found in the following links.