Elixir Language
ExDoc

introduzione

Per generare documentazione in formato HTML dagli attributi @doc e @moduledoc nel codice sorgente, aggiungi ex_doc e un processore markdown, in questo momento ExDoc supporta Earmark , Pandoc , Hoedown e Cmark , come dipendenze nel tuo file mix.exs :

# config/mix.exs

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

Se si desidera utilizzare un altro processore Markdown, è possibile trovare ulteriori informazioni nella sezione Modifica il Markdown .

Puoi utilizzare Markdown negli @doc Elixir @doc e @moduledoc .

Quindi, avvia i mix docs .

Una cosa da tenere a mente è che ExDoc consente i parametri di configurazione, come ad esempio:

  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

Puoi visualizzare maggiori informazioni su queste opzioni di configurazione con i mix help docs