Elixir Language
ExDoc

Invoering

De documentatie in het genereren van HTML -indeling van @doc en @moduledoc attributen in uw broncode, voeg ex_doc en een afwaardering processor, nu ExDoc steunen oormerk , Pandoc , Hoedown en Cmark , als afhankelijkheden in uw mix.exs file:

# config/mix.exs

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

Als u een andere Markdown-processor wilt gebruiken, vindt u meer informatie in het gedeelte Het gereedschap Markdown wijzigen .

Je kunt Markdown gebruiken binnen Elixir @doc en @moduledoc attributen.

Voer vervolgens mix docs .

Een ding om in gedachten te houden is dat ExDoc configuratieparameters toestaat, zoals:

  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

U kunt meer informatie over deze configuratie-opties bekijken in mix help docs met mix help docs functies