Web Dev Solutions

Catalin Mititiuc

aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCatalin Mititiuc <webdevcat@proton.me>2024-12-19 17:19:22 -0800
committerCatalin Mititiuc <webdevcat@proton.me>2024-12-19 17:49:39 -0800
commit3d1ea3183c4de1690533cc01d1fa843bcea2e57e (patch)
treeb8617bcac33dda0597924253b27afbca76cf05d2 /README.md
parentccb050102a3d5584fd7f7ad504583e8f43f5458d (diff)
Bump versionv0.2.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 23 insertions, 9 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>.
-