From eb419cd15e8a7398d4f6df77f5a3821b515ef0c8 Mon Sep 17 00:00:00 2001 From: Michal Muskala Date: Sat, 3 Jun 2017 20:53:36 +0200 Subject: [PATCH] Add references to 'Writing documentation' page --- README.md | 3 +++ mix.exs | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e8769df63..bc59c5943 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ ExDoc is a tool to generate documentation for your Elixir projects. In case you are looking for documentation for Elixir itself, [check out Elixir's website][elixir-lang]. +To learn about how to document your projects check out [Elixir's writing documentation page][hex-writing-docs]. + ## Using ExDoc with Mix To use ExDoc in your Mix projects, first add ExDoc as a dependency: @@ -136,3 +138,4 @@ Check the [LICENSE](LICENSE) file for more information. [cmark]: https://github.com/jgm/cmark [cmark.ex]: https://github.com/asaaki/cmark.ex [devinus/markdown]: http://github.com/devinus/markdown +[hex-writing-docs]: https://hexdocs.pm/elixir/writing-documentation.html diff --git a/mix.exs b/mix.exs index 365d99044..dccabcb8a 100644 --- a/mix.exs +++ b/mix.exs @@ -34,7 +34,8 @@ defmodule ExDoc.Mixfile do defp package do [licenses: ["Apache 2.0"], maintainers: ["José Valim", "Eksperimental", "Milton Mazzarri", "Friedel Ziegelmayer"], - links: %{"GitHub" => "https://github.com/elixir-lang/ex_doc"}] + links: %{"GitHub" => "https://github.com/elixir-lang/ex_doc", + "Writing documentation" => "https://hexdocs.pm/elixir/writing-documentation.html"}] end def escript do