Chore: Add documentation with vitepress

toneflix · Aug 12, 2024 · 0c332b9 · 0c332b9
1 parent 1986785
commit 0c332b9
Show file tree

Hide file tree

Showing 139 changed files with 3,313 additions and 489 deletions.
diff --git a/app/Models/State.php b/app/Models/State.php
@@ -27,6 +27,7 @@ public function resolveRouteBinding($value, $field = null)
     {
         return $this->where('id', $value)
             ->orWhere('slug', $value)
+            ->orWhere('code', $value)
             ->firstOrFail();
     }
 

diff --git a/public/404.html b/public/404.html
@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en-US" dir="ltr">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>404 | Naija Places API</title>
+    <meta name="description" content="Not Found">
+    <meta name="generator" content="VitePress v1.3.2">
+    <link rel="preload stylesheet" href="/assets/style.CPlv4Btl.css" as="style">
+
+    <script type="module" src="/assets/app.CnOIJo_f.js"></script>
+    <link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
+    <link rel="icon" href="/docs/logo.png">
+    <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
+    <script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"api-documentation.md\":\"xuXY6zqn\",\"docs_cities.md\":\"DK8_7rZZ\",\"docs_lgas.md\":\"BdaXkkSn\",\"docs_states.md\":\"DK6hoO8P\",\"docs_units.md\":\"CGdpeR04\",\"docs_wards.md\":\"CFsaGNqr\",\"get-started.md\":\"Boj1kqYR\",\"index.md\":\"CStqGhZW\",\"main.md\":\"DW9nSWPt\",\"portal.md\":\"CdD49Mx4\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Naija Places API\",\"description\":\"One api to rule them all, query all states, Local government areas, Wards, Polling Units and Towns in Nigeria.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/docs/logo.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Portal\",\"link\":\"/portal\"}],\"sidebar\":[{\"text\":\"Usage\",\"items\":[{\"text\":\"Api Documentation\",\"link\":\"/api-documentation\"},{\"text\":\"States\",\"link\":\"/docs/states\"},{\"text\":\"LGAs\",\"link\":\"/docs/lgas\"},{\"text\":\"Wards\",\"link\":\"/docs/wards\"},{\"text\":\"Polling Units\",\"link\":\"/docs/units\"},{\"text\":\"Towns and Cities\",\"link\":\"/docs/cities\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/toneflix/naijaplaces\"}],\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2024 Toneflix\"},\"lastUpdated\":{\"text\":\"Last updated\",\"formatOptions\":{\"dateStyle\":\"full\",\"timeStyle\":\"medium\"}}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
+
+  </body>
+</html>
diff --git a/public/api-documentation.html b/public/api-documentation.html
diff --git a/public/assets/api-documentation.md.xuXY6zqn.js b/public/assets/api-documentation.md.xuXY6zqn.js
diff --git a/public/assets/api-documentation.md.xuXY6zqn.lean.js b/public/assets/api-documentation.md.xuXY6zqn.lean.js
diff --git a/public/assets/app.CnOIJo_f.js b/public/assets/app.CnOIJo_f.js
diff --git a/public/assets/chunks/framework.C7qdVxhl.js b/public/assets/chunks/framework.C7qdVxhl.js
diff --git a/public/assets/chunks/theme.BcISMnPr.js b/public/assets/chunks/theme.BcISMnPr.js