Elixir Language
ExDoc

introduction

Pour générer de la documentation au format HTML partir des @doc et @moduledoc de votre code source, ajoutez ex_doc et un processeur de démarque, pour le moment ExDoc prend en charge Earmark , Pandoc , Hoedown et Cmark , en tant que dépendances dans votre fichier mix.exs :

# config/mix.exs

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

Si vous souhaitez utiliser un autre processeur Markdown, vous pouvez trouver plus d'informations dans la section Outil Modification du Markdown .

Vous pouvez utiliser Markdown dans les @doc Elixir @doc et @moduledoc .

Ensuite, lancez mix docs .

Une chose à garder à l'esprit est que ExDoc autorise les paramètres de configuration, tels que:

  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

Vous pouvez voir plus d'informations sur ces options de configuration avec l' mix help docs