ExDoc 介绍

要 @doc 产生 HTML 格式的文档和源代码 @moduledoc 属性，添加 ex_doc 和降价的处理器，现在 ExDoc 支持拨出 ， Pandoc ，农村舞会和 Cmark ，作为依赖到你 mix.exs 文件：

# config/mix.exs

def deps do
  [{:ex_doc, "~> 0.11", only: :dev},
   {:earmark, "~> 0.1", only: :dev}]
end

如果要使用其他 Markdown 处理器，可以在更改降价工具部分中找到更多信息。

你可以在 Elixir @doc 和 @moduledoc 属性中使用 Markdown。

然后，运行 mix docs。

要记住的一件事是 ExDoc 允许配置参数，例如：

  def project do
    [app: :my_app,
     version: "0.1.0-dev",
     name: "My App",
     source_url: "https://github.com/USER/APP",
     homepage_url: "http://YOUR_PROJECT_HOMEPAGE",
     deps: deps(),
     docs: [logo: "path/to/logo.png",
            output: "docs",
            main: "README",
            extra_section: "GUIDES",
            extras: ["README.md", "CONTRIBUTING.md"]]]
  end

你可以使用 mix help docs 查看有关此配置选项的更多信息