Add README.md and CHANGELOG.md to the docs (#168)

README.md is now the entry point of the docs instead of "API Reference".
phoenixframework · Aug 27, 2024 · a685ccf · a685ccf
1 parent e9160bd
commit a685ccf
Showing 1 changed file with 13 additions and 4 deletions.
diff --git a/mix.exs b/mix.exs
@@ -16,10 +16,7 @@ defmodule PhoenixLiveReload.Mixfile do
 
       # Docs
       name: "Phoenix Live-Reload",
-      docs: [
-        source_ref: "v#{@version}",
-        source_url: "https://github.com/phoenixframework/phoenix_live_reload"
-      ]
+      docs: docs()
     ]
   end
 
@@ -48,4 +45,16 @@ defmodule PhoenixLiveReload.Mixfile do
       {:jason, "~> 1.0", only: :test}
     ]
   end
+
+  defp docs do
+    [
+      main: "readme",
+      extras: [
+        "README.md",
+        "CHANGELOG.md"
+      ],
+      source_ref: "v#{@version}",
+      source_url: "https://github.com/phoenixframework/phoenix_live_reload"
+    ]
+  end
 end