Elixir Language
Exdoc

Introducción

Para generar la documentación en HTML formato de @doc y @moduledoc atributos en el código fuente, añadir ex_doc y un procesador de reducción del precio, en este momento ExDoc apoya Earmark , Pandoc , Hoedown y Cmark , como dependencias en su mix.exs archivo:

# config/mix.exs

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

Si desea utilizar otro procesador Markdown, puede encontrar más información en la sección Cambiar la herramienta Markdown .

Puede utilizar Markdown dentro de los @doc Elixir @doc y @moduledoc .

Luego, ejecute mix docs .

Una cosa a tener en cuenta es que ExDoc permite parámetros de configuración, tales como:

  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

Puede ver más información sobre estas opciones de configuración con mix help docs