Web Dev Solutions

Catalin Mititiuc

aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md32
-rw-r--r--mix.exs15
2 files changed, 35 insertions, 12 deletions
diff --git a/README.md b/README.md
index daab11f..9a00282 100644
--- a/README.md
+++ b/README.md
@@ -14,10 +14,17 @@ A watcher and a Mix task that uses Pandoc to convert markdown files to html.
def deps do
[
- {:pandoc, "~> 0.1.0", runtime: Mix.env() == :dev}
+ {:pandoc, "~> 0.2.0", runtime: Mix.env() == :dev}
]
end
+```
+
+## Use
+```elixir
+# mix.exs
+
+# ...
defp aliases do
[
# ...
@@ -131,7 +138,19 @@ defmodule Stasis.Document do
```
```elixir
-# lib/hello_web/controllers/post_html/index.html.heex
+# lib/hello_web/controllers/post_html.ex
+
+# ...
+
+defp href(filename, draft \\ false) do
+ root = (draft && "/drafts") || "/posts"
+ Path.join(root, filename |> Path.basename(".md"))
+end
+
+```
+
+```heex
+<!-- lib/hello_web/controllers/post_html/index.html.heex -->
<%= for {id, data} <- @posts do %>
<p>
@@ -142,13 +161,8 @@ defmodule Stasis.Document do
<% end %>
```
-```elixir
-# lib/hello_web/controllers/post_html/show.html.heex
+```heex
+<!-- lib/hello_web/controllers/post_html/show.html.heex -->
<%= raw(@post) %>
```
-
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at <https://hexdocs.pm/pandoc>.
-
diff --git a/mix.exs b/mix.exs
index e124a56..7a0bb94 100644
--- a/mix.exs
+++ b/mix.exs
@@ -1,14 +1,23 @@
defmodule Pandoc.MixProject do
use Mix.Project
+ @version "0.2.0"
+ @source_url "https://webdevcat.me/git/pandoc/"
+
def project do
[
app: :pandoc,
- version: "0.1.0",
+ version: @version,
elixir: "~> 1.14",
deps: deps(),
- description: "Pandoc",
- package: [links: [], licenses: ["MIT"]]
+ description: "File-watcher and Mix task to convert Markdown files to HTML",
+ package: [
+ links: %{
+ "pandoc" => "https://pandoc.org/"
+ },
+ licenses: ["MIT"]
+ ],
+ source_url: @source_url
]
end