Skip to content

Add references to 'Writing documentation' page #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 4, 2017
Merged

Add references to 'Writing documentation' page #737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
3 changes: 2 additions & 1 deletion mix.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down