Skip to content

Commit

Permalink
Update and cleanup hexdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
sheharyarn committed Jul 31, 2024
1 parent 2e2ea6d commit 71170aa
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 17 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!-- Heading: Start -->
<h1 align="center">
<div align="center">
<a href="https://hexdocs.pm/memento">
<img alt="Memento" src='media/logo.png' width='450px'/>
<img alt="Memento" src="media/logo.png" width="450px"/>
</a>
</h1>
</div>


<p align="center">
Expand Down
3 changes: 1 addition & 2 deletions lib/memento/memento.ex
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ defmodule Memento do
Simple + Powerful interface to the Erlang Mnesia Database.
See the [README](https://github.com/sheharyarn/memento) to get
started.
See the [README](https://hexdocs.pm/memento) to get started.
"""


Expand Down
36 changes: 24 additions & 12 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,9 @@ defmodule Memento.Mixfile do
description: description(),
package: package(),
deps: deps(),
docs: docs(),
elixirc_paths: elixirc_paths(Mix.env),

# ExDoc
name: @name,
source_url: @github,
homepage_url: @github,
docs: [
main: @name,
canonical: "https://hexdocs.pm/#{@app}",
extras: ["README.md"]
]
homepage_url: @github,
]
end

Expand Down Expand Up @@ -76,8 +68,28 @@ defmodule Memento.Mixfile do
name: @app,
maintainers: [@author],
licenses: [@license],
files: ~w(mix.exs lib README.md),
links: %{"Github" => @github}
files: ~w(mix.exs lib README.md CHANGELOG.md),
links: %{"GitHub" => @github}
]
end


# ExDoc
defp docs do
[
name: @name,
main: "readme",
source_url: @github,
source_ref: "v#{@version}",
canonical: "https://hexdocs.pm/#{@app}",
extras: [
{"README.md", title: @name},
"CHANGELOG.md",
"LICENSE"
],
assets: %{
"media" => "media"
}
]
end
end

0 comments on commit 71170aa

Please sign in to comment.