Skip to content

Commit

Permalink
Feat: Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@3m1n3nc3
3m1n3nc3 committed Jan 11, 2025
1 parent f77020e commit 7c7e6ef
Show file tree
Hide file tree
Showing 67 changed files with 138 additions and 138 deletions.
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"scripts": {
"dev": "vite",
"build": "vite build",
"docs:deploy": "yarn docs:build && git add . && git commit -m \"Chore: Rebuild documentation\" && git push",
"docs:deploy": "yarn docs:build && git add . && git commit -m \"Feat: Rebuild documentation\" && git push",
"docs:build": "cd ./website && yarn docs:build && cd ../ && yarn docs:update",
"docs:cleanup": "rm -rf ./public/doc-assets/ ./public/docs ./public/portal && rm ./public/404.html ./public/api-documentation.html ./public/demo.html ./public/get-started.html ./public/index.html ./public/hashmap.json",
"docs:update": "yarn docs:cleanup && cp -rf ./website/.vitepress/dist/* ./public && cp ./website/docs/*.{svg,png,jpg} ./public/docs/"
Expand Down
4 changes: 2 additions & 2 deletions public/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>404 | Toneflix Places API</title>

<meta name="generator" content="VitePress v1.3.2">
<link rel="preload stylesheet" href="/doc-assets/style.DYutow-A.css" as="style">
<link rel="preload stylesheet" href="/doc-assets/style.Jkq-QQoh.css" as="style">

<script type="module" src="/doc-assets/app.Bj9vapqE.js"></script>
<link rel="preload" href="/doc-assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
Expand All @@ -22,7 +22,7 @@
</head>
<body>
<div id="app"></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api-documentation.md\":\"qrgV48x7\",\"demo.md\":\"wfvwDRu5\",\"docs_cars.md\":\"Df_kLrpg\",\"docs_cars_countries.md\":\"gbMeBVGk\",\"docs_cars_demo.md\":\"DzDd7Bhv\",\"docs_cars_derivatives.md\":\"DHZJeyN4\",\"docs_cars_engines.md\":\"BiTndVZC\",\"docs_cars_manufacturers.md\":\"CjTDMDor\",\"docs_cars_mileages.md\":\"CH4tW-mo\",\"docs_cars_models.md\":\"Bx2m1FZi\",\"docs_cars_vehicles.md\":\"BdIJ0uYh\",\"docs_cars_years.md\":\"CkOE3Yr1\",\"docs_cities.md\":\"5VIxDVS4\",\"docs_lgas.md\":\"BxzsaWy-\",\"docs_states.md\":\"CV4Kh7mH\",\"docs_units.md\":\"NmTiLAlj\",\"docs_wards.md\":\"BdXuvM22\",\"docs_world_cities.md\":\"PPaH2DOe\",\"docs_world_countries.md\":\"BzkU2EJ5\",\"docs_world_demo.md\":\"C_d4gnF5\",\"docs_world_regions.md\":\"C-x_lUGR\",\"docs_world_states.md\":\"Cdcq9bUH\",\"docs_world_subregions.md\":\"D9uv7FRf\",\"get-started.md\":\"DGvNDmi0\",\"index.md\":\"DDsuk9lT\",\"portal_api-key.md\":\"DgPuWlW2\",\"portal_api-keys.md\":\"8eR_ppbv\",\"portal_home.md\":\"4gIexFq8\",\"portal_login.md\":\"CHjmis0K\",\"portal_register.md\":\"D5CBve8j\",\"portal_reset-password.md\":\"CZMi9D65\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Toneflix Places API\",\"description\":\"One api to rule them all, query all states, Local government areas, Wards, Polling Units and Towns in Nigeria + all world regions, countries, states and cities.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/docs/logo.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Demo\",\"link\":\"/demo\"},{\"text\":\"Portal\",\"link\":\"/portal/home\"}],\"sidebar\":[{\"text\":\"Usage\",\"items\":[{\"text\":\"Api Documentation\",\"link\":\"/api-documentation\"}]},{\"text\":\"Naija Geolocation\",\"items\":[{\"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\"}]},{\"text\":\"World Geolocation\",\"items\":[{\"text\":\"Regions\",\"link\":\"/docs/world/regions\"},{\"text\":\"Subregions\",\"link\":\"/docs/world/subregions\"},{\"text\":\"Countries\",\"link\":\"/docs/world/countries\"},{\"text\":\"States\",\"link\":\"/docs/world/states\"},{\"text\":\"Cities\",\"link\":\"/docs/world/cities\"}]},{\"text\":\"Car API\",\"link\":\"/docs/cars\",\"items\":[{\"text\":\"Countries/Origins\",\"link\":\"/docs/cars/countries\"},{\"text\":\"Make Years\",\"link\":\"/docs/cars/years\"},{\"text\":\"Manufacturers\",\"link\":\"/docs/cars/manufacturers\"},{\"text\":\"Vehicles\",\"link\":\"/docs/cars/vehicles\"},{\"text\":\"Derivatives\",\"link\":\"/docs/cars/derivatives\"},{\"text\":\"Mileages\",\"link\":\"/docs/cars/mileages\"},{\"text\":\"Engines\",\"link\":\"/docs/cars/engines\"},{\"text\":\"Models\",\"link\":\"/docs/cars/models\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/toneflix/naija-places\"}],\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2025 Toneflix\"},\"lastUpdated\":{\"text\":\"Last updated\",\"formatOptions\":{\"dateStyle\":\"full\",\"timeStyle\":\"medium\"}}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api-documentation.md\":\"wROcq5We\",\"demo.md\":\"wfvwDRu5\",\"docs_cars.md\":\"Df_kLrpg\",\"docs_cars_countries.md\":\"aZQGWWUL\",\"docs_cars_demo.md\":\"DzDd7Bhv\",\"docs_cars_derivatives.md\":\"DHZJeyN4\",\"docs_cars_engines.md\":\"BiTndVZC\",\"docs_cars_manufacturers.md\":\"PmXKuhyN\",\"docs_cars_mileages.md\":\"CH4tW-mo\",\"docs_cars_models.md\":\"Bx2m1FZi\",\"docs_cars_vehicles.md\":\"DNyuSIk8\",\"docs_cars_years.md\":\"BngIJ4WX\",\"docs_cities.md\":\"Dw1lzNJ5\",\"docs_lgas.md\":\"DWTJZOR7\",\"docs_states.md\":\"DyCKDMB4\",\"docs_units.md\":\"DrvclpIM\",\"docs_wards.md\":\"CUBkL2Yd\",\"docs_world_cities.md\":\"lzlRrR3S\",\"docs_world_countries.md\":\"CA0VoDsK\",\"docs_world_demo.md\":\"C_d4gnF5\",\"docs_world_regions.md\":\"BCMHzlbV\",\"docs_world_states.md\":\"BWaUHzvN\",\"docs_world_subregions.md\":\"B_sqnsC8\",\"get-started.md\":\"DGvNDmi0\",\"index.md\":\"DDsuk9lT\",\"portal_api-key.md\":\"DgPuWlW2\",\"portal_api-keys.md\":\"8eR_ppbv\",\"portal_home.md\":\"4gIexFq8\",\"portal_login.md\":\"CHjmis0K\",\"portal_register.md\":\"D5CBve8j\",\"portal_reset-password.md\":\"CZMi9D65\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Toneflix Places API\",\"description\":\"One api to rule them all, query all states, Local government areas, Wards, Polling Units and Towns in Nigeria + all world regions, countries, states and cities.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/docs/logo.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Demo\",\"link\":\"/demo\"},{\"text\":\"Portal\",\"link\":\"/portal/home\"}],\"sidebar\":[{\"text\":\"Usage\",\"items\":[{\"text\":\"Api Documentation\",\"link\":\"/api-documentation\"}]},{\"text\":\"Naija Geolocation\",\"items\":[{\"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\"}]},{\"text\":\"World Geolocation\",\"items\":[{\"text\":\"Regions\",\"link\":\"/docs/world/regions\"},{\"text\":\"Subregions\",\"link\":\"/docs/world/subregions\"},{\"text\":\"Countries\",\"link\":\"/docs/world/countries\"},{\"text\":\"States\",\"link\":\"/docs/world/states\"},{\"text\":\"Cities\",\"link\":\"/docs/world/cities\"}]},{\"text\":\"Car API\",\"link\":\"/docs/cars\",\"items\":[{\"text\":\"Countries/Origins\",\"link\":\"/docs/cars/countries\"},{\"text\":\"Make Years\",\"link\":\"/docs/cars/years\"},{\"text\":\"Manufacturers\",\"link\":\"/docs/cars/manufacturers\"},{\"text\":\"Vehicles\",\"link\":\"/docs/cars/vehicles\"},{\"text\":\"Derivatives\",\"link\":\"/docs/cars/derivatives\"},{\"text\":\"Mileages\",\"link\":\"/docs/cars/mileages\"},{\"text\":\"Engines\",\"link\":\"/docs/cars/engines\"},{\"text\":\"Models\",\"link\":\"/docs/cars/models\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/toneflix/naija-places\"}],\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2025 Toneflix\"},\"lastUpdated\":{\"text\":\"Last updated\",\"formatOptions\":{\"dateStyle\":\"full\",\"timeStyle\":\"medium\"}}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>

</body>
</html>
8 changes: 4 additions & 4 deletions public/api-documentation.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions public/demo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>Local Demo | Toneflix Places API</title>

<meta name="generator" content="VitePress v1.3.2">
<link rel="preload stylesheet" href="/doc-assets/style.DYutow-A.css" as="style">
<link rel="preload stylesheet" href="/doc-assets/style.Jkq-QQoh.css" as="style">

<script type="module" src="/doc-assets/app.Bj9vapqE.js"></script>
<link rel="preload" href="/doc-assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
Expand All @@ -31,7 +31,7 @@
<span class="line"> "ward": "loading...",</span>
<span class="line"> "unit": "loading..."</span>
<span class="line">}</span></code></pre></div></div></div></div></div></div></main><footer class="VPDocFooter" data-v-e6f2a212 data-v-1bcd8184><!--[--><!--]--><div class="edit-info" data-v-1bcd8184><!----><div class="last-updated" data-v-1bcd8184><p class="VPLastUpdated" data-v-1bcd8184 data-v-1bb0c8a8>Last updated: <time datetime="2025-01-06T14:42:10.000Z" data-v-1bb0c8a8></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-1bcd8184><span class="visually-hidden" id="doc-footer-aria-label" data-v-1bcd8184>Pager</span><div class="pager" data-v-1bcd8184><!----></div><div class="pager" data-v-1bcd8184><a class="VPLink link pager-link next" href="/api-documentation" data-v-1bcd8184><!--[--><span class="desc" data-v-1bcd8184>Next page</span><span class="title" data-v-1bcd8184>Api Documentation</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-d8b57b2d data-v-566314d4><div class="container" data-v-566314d4><p class="message" data-v-566314d4>Released under the MIT License.</p><p class="copyright" data-v-566314d4>Copyright © 2025 Toneflix</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api-documentation.md\":\"qrgV48x7\",\"demo.md\":\"wfvwDRu5\",\"docs_cars.md\":\"Df_kLrpg\",\"docs_cars_countries.md\":\"gbMeBVGk\",\"docs_cars_demo.md\":\"DzDd7Bhv\",\"docs_cars_derivatives.md\":\"DHZJeyN4\",\"docs_cars_engines.md\":\"BiTndVZC\",\"docs_cars_manufacturers.md\":\"CjTDMDor\",\"docs_cars_mileages.md\":\"CH4tW-mo\",\"docs_cars_models.md\":\"Bx2m1FZi\",\"docs_cars_vehicles.md\":\"BdIJ0uYh\",\"docs_cars_years.md\":\"CkOE3Yr1\",\"docs_cities.md\":\"5VIxDVS4\",\"docs_lgas.md\":\"BxzsaWy-\",\"docs_states.md\":\"CV4Kh7mH\",\"docs_units.md\":\"NmTiLAlj\",\"docs_wards.md\":\"BdXuvM22\",\"docs_world_cities.md\":\"PPaH2DOe\",\"docs_world_countries.md\":\"BzkU2EJ5\",\"docs_world_demo.md\":\"C_d4gnF5\",\"docs_world_regions.md\":\"C-x_lUGR\",\"docs_world_states.md\":\"Cdcq9bUH\",\"docs_world_subregions.md\":\"D9uv7FRf\",\"get-started.md\":\"DGvNDmi0\",\"index.md\":\"DDsuk9lT\",\"portal_api-key.md\":\"DgPuWlW2\",\"portal_api-keys.md\":\"8eR_ppbv\",\"portal_home.md\":\"4gIexFq8\",\"portal_login.md\":\"CHjmis0K\",\"portal_register.md\":\"D5CBve8j\",\"portal_reset-password.md\":\"CZMi9D65\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Toneflix Places API\",\"description\":\"One api to rule them all, query all states, Local government areas, Wards, Polling Units and Towns in Nigeria + all world regions, countries, states and cities.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/docs/logo.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Demo\",\"link\":\"/demo\"},{\"text\":\"Portal\",\"link\":\"/portal/home\"}],\"sidebar\":[{\"text\":\"Usage\",\"items\":[{\"text\":\"Api Documentation\",\"link\":\"/api-documentation\"}]},{\"text\":\"Naija Geolocation\",\"items\":[{\"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\"}]},{\"text\":\"World Geolocation\",\"items\":[{\"text\":\"Regions\",\"link\":\"/docs/world/regions\"},{\"text\":\"Subregions\",\"link\":\"/docs/world/subregions\"},{\"text\":\"Countries\",\"link\":\"/docs/world/countries\"},{\"text\":\"States\",\"link\":\"/docs/world/states\"},{\"text\":\"Cities\",\"link\":\"/docs/world/cities\"}]},{\"text\":\"Car API\",\"link\":\"/docs/cars\",\"items\":[{\"text\":\"Countries/Origins\",\"link\":\"/docs/cars/countries\"},{\"text\":\"Make Years\",\"link\":\"/docs/cars/years\"},{\"text\":\"Manufacturers\",\"link\":\"/docs/cars/manufacturers\"},{\"text\":\"Vehicles\",\"link\":\"/docs/cars/vehicles\"},{\"text\":\"Derivatives\",\"link\":\"/docs/cars/derivatives\"},{\"text\":\"Mileages\",\"link\":\"/docs/cars/mileages\"},{\"text\":\"Engines\",\"link\":\"/docs/cars/engines\"},{\"text\":\"Models\",\"link\":\"/docs/cars/models\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/toneflix/naija-places\"}],\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2025 Toneflix\"},\"lastUpdated\":{\"text\":\"Last updated\",\"formatOptions\":{\"dateStyle\":\"full\",\"timeStyle\":\"medium\"}}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api-documentation.md\":\"wROcq5We\",\"demo.md\":\"wfvwDRu5\",\"docs_cars.md\":\"Df_kLrpg\",\"docs_cars_countries.md\":\"aZQGWWUL\",\"docs_cars_demo.md\":\"DzDd7Bhv\",\"docs_cars_derivatives.md\":\"DHZJeyN4\",\"docs_cars_engines.md\":\"BiTndVZC\",\"docs_cars_manufacturers.md\":\"PmXKuhyN\",\"docs_cars_mileages.md\":\"CH4tW-mo\",\"docs_cars_models.md\":\"Bx2m1FZi\",\"docs_cars_vehicles.md\":\"DNyuSIk8\",\"docs_cars_years.md\":\"BngIJ4WX\",\"docs_cities.md\":\"Dw1lzNJ5\",\"docs_lgas.md\":\"DWTJZOR7\",\"docs_states.md\":\"DyCKDMB4\",\"docs_units.md\":\"DrvclpIM\",\"docs_wards.md\":\"CUBkL2Yd\",\"docs_world_cities.md\":\"lzlRrR3S\",\"docs_world_countries.md\":\"CA0VoDsK\",\"docs_world_demo.md\":\"C_d4gnF5\",\"docs_world_regions.md\":\"BCMHzlbV\",\"docs_world_states.md\":\"BWaUHzvN\",\"docs_world_subregions.md\":\"B_sqnsC8\",\"get-started.md\":\"DGvNDmi0\",\"index.md\":\"DDsuk9lT\",\"portal_api-key.md\":\"DgPuWlW2\",\"portal_api-keys.md\":\"8eR_ppbv\",\"portal_home.md\":\"4gIexFq8\",\"portal_login.md\":\"CHjmis0K\",\"portal_register.md\":\"D5CBve8j\",\"portal_reset-password.md\":\"CZMi9D65\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Toneflix Places API\",\"description\":\"One api to rule them all, query all states, Local government areas, Wards, Polling Units and Towns in Nigeria + all world regions, countries, states and cities.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/docs/logo.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Demo\",\"link\":\"/demo\"},{\"text\":\"Portal\",\"link\":\"/portal/home\"}],\"sidebar\":[{\"text\":\"Usage\",\"items\":[{\"text\":\"Api Documentation\",\"link\":\"/api-documentation\"}]},{\"text\":\"Naija Geolocation\",\"items\":[{\"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\"}]},{\"text\":\"World Geolocation\",\"items\":[{\"text\":\"Regions\",\"link\":\"/docs/world/regions\"},{\"text\":\"Subregions\",\"link\":\"/docs/world/subregions\"},{\"text\":\"Countries\",\"link\":\"/docs/world/countries\"},{\"text\":\"States\",\"link\":\"/docs/world/states\"},{\"text\":\"Cities\",\"link\":\"/docs/world/cities\"}]},{\"text\":\"Car API\",\"link\":\"/docs/cars\",\"items\":[{\"text\":\"Countries/Origins\",\"link\":\"/docs/cars/countries\"},{\"text\":\"Make Years\",\"link\":\"/docs/cars/years\"},{\"text\":\"Manufacturers\",\"link\":\"/docs/cars/manufacturers\"},{\"text\":\"Vehicles\",\"link\":\"/docs/cars/vehicles\"},{\"text\":\"Derivatives\",\"link\":\"/docs/cars/derivatives\"},{\"text\":\"Mileages\",\"link\":\"/docs/cars/mileages\"},{\"text\":\"Engines\",\"link\":\"/docs/cars/engines\"},{\"text\":\"Models\",\"link\":\"/docs/cars/models\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/toneflix/naija-places\"}],\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2025 Toneflix\"},\"lastUpdated\":{\"text\":\"Last updated\",\"formatOptions\":{\"dateStyle\":\"full\",\"timeStyle\":\"medium\"}}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>

</body>
</html>
Loading

0 comments on commit 7c7e6ef

Please sign in to comment.