Packages

ex_doc

0.6.1
0.40.3 0.40.2 0.40.1 0.40.0 0.39.3 0.39.2 0.39.1 0.39.0 0.38.4 0.38.3 0.38.2 0.38.1 0.38.0 0.37.3 0.37.2 0.37.1 0.37.0 0.37.0-rc.2 0.37.0-rc.1 0.37.0-rc.0 0.36.1 0.36.0 0.35.1 0.35.0 0.34.2 0.34.1 0.34.0 0.33.0 0.32.2 0.32.1 0.32.0 0.31.2 0.31.1 0.31.0 0.30.9 0.30.8 0.30.7 0.30.6 0.30.5 0.30.4 0.30.3 0.30.2 0.30.1 0.30.0 0.29.4 0.29.3 0.29.2 0.29.1 0.29.0 0.28.6 0.28.5 0.28.4 0.28.3 0.28.2 0.28.1 0.28.0 0.27.3 0.27.2 0.27.1 0.27.0 0.26.0 0.25.5 0.25.4 0.25.3 0.25.2 0.25.1 0.25.0 0.24.2 0.24.1 0.24.0 0.23.0 0.22.6 0.22.5 0.22.4 0.22.2 0.22.1 0.22.0 0.21.3 0.21.2 0.21.1 0.21.0 0.20.2 0.20.1 0.20.0 0.19.3 0.19.2 0.19.1 0.19.0 0.19.0-rc 0.18.4 0.18.3 0.18.2 0.18.1 0.18.0 retired 0.17.1 0.17.0 retired 0.16.4 0.16.3 0.16.2 0.16.1 0.16.0 0.15.1 0.15.0 0.14.5 0.14.4 0.14.3 0.14.2 0.14.1 0.14.0 0.13.2 0.13.1 0.13.0 0.12.0 0.11.5 0.11.4 0.11.3 0.11.2 0.11.1 0.11.0 0.10.0 0.9.0 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.3 0.7.2 0.7.1 0.7.0 0.6.2 0.6.1 0.6.0 0.5.2 0.5.1

ExDoc is a documentation generation tool for Elixir

HexDocs

Current section

Files

Jump to
Readme
135 Versions
0 Dependencies
Dependants
Files
Activity
ex_doc README.md
Raw

README.md 

# ExDoc



ExDoc is a tool to generate documentation for your Elixir projects. In case you are looking for documentation for Elixir itself, [check out Elixir's website](http://elixir-lang.org/).



## Using ExDoc with Mix



To use ExDoc in your Mix projects, first add ExDoc as a dependency:



```elixir

def deps do

  [{:earmark, "~> 0.1", only: :dev},

   {:ex_doc, "~> 0.6", only: :dev}]

end

```



After adding ExDoc as a dependency, run `mix deps.get` to install it.



ExDoc will automatically pull in information from your project, like the application and version. However, you may want to set `:name`, `:source_url` and `:homepage_url` to have a nicer output from ExDoc, for example:



```elixir

def project do

  [app: :repo

   version: "0.1.0-dev",

   name: "REPO",

   source_url: "https://github.com/USER/REPO",

   homepage_url: "http://YOUR_PROJECT_HOMEPAGE"

   deps: deps]

end

```



Now you are ready to generate your project documentation with `mix docs`.



## Using ExDoc via command line



You can ExDoc via the command line as follows:



1. First clone and compile it:



        git clone https://github.com/elixir-lang/ex_doc.git

        cd ex_doc

        mix do deps.get, compile



2. Then you are ready to use it in your projects. First move into your project directory and ensure it is compiled:



        cd PATH_TO_YOUR_PROJECT

        mix compile



3. Next invoke the ex_doc executable from your project:



        PATH_TO_YOUR_EXDOC/bin/ex_doc "PROJECT_NAME" "PROJECT_VERSION" path/to/project/ebin -m "PROJECT_MODULE" -u "https://github.com/GITHUB_USER/GITHUB_REPO"



For example, here are some acceptable values:



    PROJECT_NAME    => Dynamo

    PROJECT_VERSION => 0.1.0

    PROJECT_MODULE  => Dynamo (the main module provided by the library)

    GITHUB_USER     => elixir-lang

    GITHUB_REPO     => dynamo



## Changing the Markdown tool



In the examples above, we have used [Earmark](http://github.com/pragdave/earmark) to convert Markdown to HTML. If you prefer, you can also use pandoc or hoedown (in C):



  * Install [pandoc](http://johnmacfarlane.net/pandoc/) - which is available in multiple package managers and provides installers for different operating systems. Pandoc must be installed just once and it will be used for all projects;



  * To use hoedown - add http://github.com/devinus/markdown as a dependency to your project as: `{:markdown, github: "devinus/markdown"}`



Then add the entry:



    config :ex_doc, :markdown_processor, ExDoc.Markdown.Pandoc  # or ExDoc.Markdown.Hoedown



to your `config/config.exs` file.



To see all options available when generating docs, just run `mix help docs`.



# License



ExDoc source code is released under Apache 2 License with snippets under MIT-LICENSE.



Check LICENSE file for more information.