Elixir Language
ExDoc

Вступление

Чтобы генерировать документацию в формате HTML из @doc и @moduledoc в исходном коде, добавьте ex_doc и процессор уценки, прямо сейчас ExDoc поддерживает Earmark , Pandoc , Hoedown и Cmark в качестве зависимостей в файле mix.exs :

# config/mix.exs

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

Если вы хотите использовать другой процессор Markdown, вы можете найти дополнительную информацию в разделе « Изменение инструмента Markdown ».

Вы можете использовать Markdown в @doc Elixir @doc и @moduledoc .

Затем запустите mix docs .

Следует иметь в виду, что ExDoc позволяет параметры конфигурации, такие как:

  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

Вы можете увидеть дополнительную информацию об этих параметрах конфигурации с mix help docs