Skip to content

Commit

Permalink
feat: perfect docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tclxshunquan-wang committed Aug 20, 2024
1 parent 2979294 commit 8def8e7
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 42 deletions.
5 changes: 0 additions & 5 deletions .changeset/funny-rivers-refuse.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/stupid-days-decide.md

This file was deleted.

6 changes: 0 additions & 6 deletions .changeset/two-buckets-cheer.md

This file was deleted.

21 changes: 0 additions & 21 deletions examples/next-example/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started

First, run the development server:
Expand All @@ -15,22 +13,3 @@ bun run dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
4 changes: 2 additions & 2 deletions examples/next-example/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "@hyperse/track-next-example",
"name": "@hyperse/next-example",
"version": "1.0.0",
"private": true,
"type": "module",
"scripts": {
"dev": "next dev -p 3001",
"dev": "next dev -p",
"build": "next build",
"start": "next start",
"lint": "eslint .",
Expand Down
2 changes: 1 addition & 1 deletion website/docs/intro/live-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Read more in [**User guide > introducing**](/docs/intro/introducing)

:::

<Stackblitz id="hyperse-track" />
<Stackblitz id="next-example" />

## Congratulations !

Expand Down
8 changes: 6 additions & 2 deletions website/src/components/Stackblitz/index.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
import React from 'react';

export default function Stackblitz(props: { id: string }) {
const GithubUrl = {
'next-example': `https://stackblitz.com/fork/github/hyperse-io/track/tree/feat/track/examples/next-example?title=next-example&startScript=dev&embed=1&theme=dark`,
};

export default function Stackblitz(props: { id: keyof typeof GithubUrl }) {
return (
<iframe
style={{
width: '100%',
minHeight: '500px',
borderRadius: '8px',
}}
src={`https://stackblitz.com/edit/${props.id}?embed=1&theme=dark`}
src={GithubUrl[props.id]}
/>
);
}
Binary file modified website/static/media/code.mp4
Binary file not shown.

0 comments on commit 8def8e7

Please sign in to comment.