Elixir Language
ExDoc

前書き

でドキュメントを生成するためHTMLからフォーマット@docと@moduledocソースコード内の属性、追加ex_docと値下げプロセッサを、今ExDocはサポートしてい充てる 、 Pandoc 、 ホーダウンとCmarkをあなたへの依存関係として、 mix.exsファイル：

# config/mix.exs

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

別のMarkdownプロセッサを使用する場合は、 「Markdownツールの変更」のセクションを参照してください。

Elixir @docと@moduledoc属性でMarkdownを使うことができます。

次に、 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を参照してください