Elixir Language
ExDoc

Einführung

So generiert Dokumentation im HTML - Format von @doc und @moduledoc Attributen in Ihrem Quellcode, fügt ex_doc und einen Abschlag Prozessor, gerade jetzt ExDoc unterstützt Earmark , Pandoc , Hoedown und Cmark , als Abhängigkeiten in Ihre mix.exs Datei:

# config/mix.exs

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

Wenn Sie einen anderen Markdown-Prozessor verwenden möchten, finden Sie weitere Informationen im Abschnitt Ändern des Markdown-Werkzeugs .

Sie können Markdown in den Attributen Elixir @doc und @moduledoc .

Führen Sie dann mix docs .

Dabei ist zu beachten, dass ExDoc Konfigurationsparameter zulässt, beispielsweise:

  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

Weitere Informationen zu diesen Konfigurationsoptionen finden Sie in den Hilfedokumenten zu mix help docs