Skip to content

Commit

Permalink
docs: keywords; title; text
Browse files Browse the repository at this point in the history
  • Loading branch information
wanjas committed Dec 8, 2023
1 parent 475e4c1 commit 13b4d58
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 12 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# react-use-url-state

![npm](https://img.shields.io/npm/v/react-use-url-state?logo=npm)
![npm type definitions](https://img.shields.io/npm/types/react-use-url-state?logo=typescript)
![npm](https://img.shields.io/npm/dw/react-use-url-state)
![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/react-use-url-state)
[![Known Vulnerabilities](https://snyk.io/test/npm/react-use-url-state/badge.svg)](https://snyk.io/test/react-use-url-state/axios)

Use URL to store a state in React.

* Easily handle numbers, dates, booleans, and arrays.
* Have a type-safety with [Zod](https://zod.dev/)
* CJS and ESM support
* 0 dependencies

> `https://example.com/?text=query&number=10&date=2023-11-29T13%3A52%3A50.230Z`
>
Expand Down
1 change: 1 addition & 0 deletions apps/docs/next-sitemap.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ module.exports = {
generateRobotsTxt: true,
sourceDir: path.resolve(__dirname, '../../dist/apps/docs/.next'),
generateIndexSitemap: false,
changefreq: 'weekly',
};
3 changes: 2 additions & 1 deletion apps/docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

React state manager that helps you to deal with `numbers`, `dates`, `arrays`, etc. in the URL params.
React state manager that helps you to deal with `numbers`, `dates`, `arrays`, etc. in the URL search params.

Get sharable links with the current state of your app.

Expand All @@ -9,3 +9,4 @@ Get sharable links with the current state of your app.
> `<=>`
>
> `{ text: 'query', number: 10, date: new Date('2023-11-29T13:52:50.230Z') }`
22 changes: 11 additions & 11 deletions apps/docs/public/sitemap.xml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">
<url><loc>https://react-use-url-state.vercel.app</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/api-reference</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/contributing</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/advanced</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/arrays</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/basic</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/initial-value</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/initial-value-applied</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/passthrough</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/installation</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/quick-start</loc><lastmod>2023-12-02T03:09:02.465Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/api-reference</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/contributing</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/advanced</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/arrays</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/basic</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/initial-value</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/initial-value-applied</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/examples/passthrough</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/installation</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
<url><loc>https://react-use-url-state.vercel.app/quick-start</loc><lastmod>2023-12-08T04:15:26.761Z</lastmod><changefreq>weekly</changefreq><priority>0.7</priority></url>
</urlset>
4 changes: 4 additions & 0 deletions apps/docs/theme.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,15 @@ const config: DocsThemeConfig = {
// chat: {
// link: 'https://discord.com',
// },

docsRepositoryBase:
'https://github.com/wanjas/react-use-url-state/tree/main/apps/docs',
footer: {
text: 'React useUrlState',
},
useNextSeoProps: () => ({
titleTemplate: '%s | useUrlState',
}),
};

export default config;

0 comments on commit 13b4d58

Please sign in to comment.