Elixir Language
ExDoc

Introduktion

För att generera dokumentation i HTML format från @doc och @moduledoc attribut i din källkod, lägg till ex_doc och en markdown-processor, just nu stöder ExDoc Earmark , Pandoc , Hoedown och Cmark , som beroenden i din mix.exs fil:

# config/mix.exs

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

Om du vill använda en annan Markdown-processor kan du hitta mer information i avsnittet Ändra Markdown-verktyget .

Du kan använda Markdown inom Elixir @doc och @moduledoc attribut.

mix docs .

En sak att tänka på är att ExDoc tillåter konfigurationsparametrar, till exempel:

  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

Du kan se mer information om de här konfigurationsalternativen med mix help docs