Skip to content
This repository was archived by the owner on Feb 14, 2025. It is now read-only.

Commit

Permalink
WIP docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
bring-shrubbery committed Mar 4, 2024
1 parent 4be3f33 commit d4f43f5
Show file tree
Hide file tree
Showing 8 changed files with 917 additions and 896 deletions.
6 changes: 3 additions & 3 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
"with-env": "dotenv -e ../../.env --"
},
"dependencies": {
"@astrojs/check": "^0.5.5",
"@astrojs/starlight": "^0.19.1",
"@astrojs/check": "^0.5.6",
"@astrojs/starlight": "^0.21.1",
"@astrojs/starlight-tailwind": "^2.0.1",
"@astrojs/tailwind": "^5.1.0",
"astro": "^4.4.3",
"astro": "^4.4.10",
"dotenv-cli": "^7.3.0",
"sharp": "^0.33.2",
"tailwindcss": "^3.4.1",
Expand Down
46 changes: 19 additions & 27 deletions apps/docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,43 +4,35 @@ description: Hooks to sync and manage state with URL search params.
template: splash
hero:
title: |
Welcome to Starlight with
<span
class="font-black text-transparent
bg-clip-text bg-gradient-to-b
from-accent-700 to-accent-400
dark:from-accent-500 dark:to-accent-200"
>
Tailwind
</span>
tagline: Congrats on setting up a new Starlight project!
Welcome to <br/><code class="bg-zinc-800 px-4 py-2 rounded-2xl">@sp-hooks</code>
tagline: Hooks for handling search params state in JavaScript applications
image:
file: ../../assets/houston.webp
actions:
- text: Example Guide
link: /guides/example/
- text: Getting Started
link: /getting-started/introduction
icon: right-arrow
variant: primary
- text: Read the Starlight docs
link: https://starlight.astro.build
- text: Need help developing your website/app?
link: https://quassum.com/?utm_source=sp-hooks&utm_medium=referral&utm_campaign=sp-hooks
icon: external
---

import { Card, CardGrid } from '@astrojs/starlight/components';
import { Card, CardGrid } from "@astrojs/starlight/components";

## Next steps

<CardGrid stagger>
<Card title="Update content" icon="pencil">
Edit `src/content/docs/index.mdx` to see this page change.
</Card>
<Card title="Add new content" icon="add-document">
Add Markdown or MDX files to `src/content/docs` to create new pages.
</Card>
<Card title="Configure your site" icon="setting">
Edit your `sidebar` and other config in `astro.config.mjs`.
</Card>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
</Card>
<Card title="Getting Started with React" icon="add-document">
Check out how to install and use `@sp-hooks/react` in the [Getting Started
guide](/getting-started/react).
</Card>
<Card title="Getting Started with Next.js" icon="add-document">
Check out how to install and use `@sp-hooks/next` in the [Getting Started
guide](/getting-started/nextjs).
</Card>
<Card title="Read the guides" icon="open-book">
Learn more about the hooks and how to use them in the
[Guides](/guides/basic).
</Card>
</CardGrid>
18 changes: 9 additions & 9 deletions apps/playground/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,34 +48,34 @@
"@radix-ui/react-toast": "^1.1.5",
"@radix-ui/react-toggle": "^1.0.3",
"@radix-ui/react-tooltip": "^1.0.7",
"@t3-oss/env-nextjs": "^0.7.3",
"@sp-hooks/next": "workspace:*",
"@sp-hooks/react": "workspace:*",
"@t3-oss/env-nextjs": "^0.7.3",
"@vercel/analytics": "^1.2.2",
"class-variance-authority": "^0.7.0",
"clsx": "^2.1.0",
"cmdk": "^0.2.1",
"date-fns": "^3.3.1",
"dotenv-cli": "^7.3.0",
"eslint": "^8.56.0",
"lucide-react": "^0.338.0",
"eslint": "^8.57.0",
"lucide-react": "^0.344.0",
"next-themes": "^0.2.1",
"react-day-picker": "^8.10.0",
"react-dom": "^18.2.0",
"react-hook-form": "^7.50.1",
"react-hook-form": "^7.51.0",
"tailwind-merge": "^2.2.1",
"tailwindcss-animate": "^1.0.7",
"zod": "^3.22.4"
},
"devDependencies": {
"@types/node": "^18.19.18",
"@types/react": "^18.2.58",
"@types/react-dom": "^18.2.19",
"@sp-hooks/eslint-config": "workspace:*",
"@sp-hooks/tsconfig": "workspace:*",
"autoprefixer": "^10.4.17",
"@types/node": "^18.19.21",
"@types/react": "^18.2.61",
"@types/react-dom": "^18.2.19",
"autoprefixer": "^10.4.18",
"docs": "^0.0.1",
"next": "^14.1.0",
"next": "^14.1.1",
"postcss": "^8.4.35",
"react": "^18.2.0",
"tailwindcss": "^3.4.1",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"@manypkg/cli": "^0.21.2",
"@sp-hooks/eslint-config": "workspace:*",
"@sp-hooks/prettier-config": "workspace:*",
"eslint": "^8.56.0",
"eslint": "^8.57.0",
"prettier": "^3.2.5",
"prettier-plugin-tailwindcss": "^0.5.11",
"turbo": "latest",
Expand Down
8 changes: 4 additions & 4 deletions packages/next/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@
"dotenv-cli": "^7.3.0"
},
"devDependencies": {
"@types/react": "^18.2.58",
"@types/react-dom": "^18.2.19",
"@sp-hooks/eslint-config": "workspace:*",
"@sp-hooks/tsconfig": "workspace:*",
"eslint": "^8.56.0",
"next": "^14.1.0",
"@types/react": "^18.2.61",
"@types/react-dom": "^18.2.19",
"eslint": "^8.57.0",
"next": "^14.1.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"tsup": "^8.0.2",
Expand Down
8 changes: 4 additions & 4 deletions packages/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@
"root": true
},
"devDependencies": {
"@types/react": "^18.2.58",
"@types/react-dom": "^18.2.19",
"@sp-hooks/eslint-config": "workspace:*",
"@sp-hooks/tsconfig": "workspace:*",
"eslint": "^8.56.0",
"next": "^14.1.0",
"@types/react": "^18.2.61",
"@types/react-dom": "^18.2.19",
"eslint": "^8.57.0",
"next": "^14.1.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"tsup": "^8.0.2",
Expand Down
Loading

0 comments on commit d4f43f5

Please sign in to comment.