Elixir Language
ExDoc

소개

소스 코드의 @doc 및 @moduledoc 속성에서 HTML 형식으로 문서를 생성하려면 ex_doc 및 markdown 프로세서를 추가하십시오. 이제 ExDoc은 Earmark , Pandoc , Hoedown 및 Cmark를 mix.exs 파일에 대한 종속성으로 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 통해이 구성 옵션에 대한 자세한 정보를 볼 수 있습니다.