Elixir Language
ExDoc

Wprowadzenie

Do generowania dokumentacji w HTML formacie od @doc i @moduledoc atrybutów w kodzie źródłowym, dodać ex_doc oraz procesor markdown, tuż obsługuje ExDoc przeznaczenie , Pandoc , Hoedown i Cmark , jako zależności do swojej mix.exs pliku:

# config/mix.exs

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

Jeśli chcesz użyć innego procesora Markdown, więcej informacji znajdziesz w sekcji Zmiana narzędzia Markdown .

Możesz użyć Markdown w @doc Elixir @doc i @moduledoc .

Następnie uruchom mix docs .

Należy pamiętać, że ExDoc dopuszcza parametry konfiguracyjne, takie jak:

  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

Więcej informacji na temat tych opcji konfiguracji można znaleźć w mix help docs