From 8def8e7f5d0b6f1f28767c9c459efba2dcb0a714 Mon Sep 17 00:00:00 2001 From: "shunquan.wang" Date: Tue, 20 Aug 2024 17:38:01 +0800 Subject: [PATCH] feat: perfect docs --- .changeset/funny-rivers-refuse.md | 5 ----- .changeset/stupid-days-decide.md | 5 ----- .changeset/two-buckets-cheer.md | 6 ------ examples/next-example/README.md | 21 -------------------- examples/next-example/package.json | 4 ++-- website/docs/intro/live-example.md | 2 +- website/src/components/Stackblitz/index.tsx | 8 ++++++-- website/static/media/code.mp4 | Bin 10960713 -> 3772105 bytes 8 files changed, 9 insertions(+), 42 deletions(-) delete mode 100644 .changeset/funny-rivers-refuse.md delete mode 100644 .changeset/stupid-days-decide.md delete mode 100644 .changeset/two-buckets-cheer.md diff --git a/.changeset/funny-rivers-refuse.md b/.changeset/funny-rivers-refuse.md deleted file mode 100644 index f0c1bf1..0000000 --- a/.changeset/funny-rivers-refuse.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@hyperse/track": patch ---- - -Track release diff --git a/.changeset/stupid-days-decide.md b/.changeset/stupid-days-decide.md deleted file mode 100644 index a6cbed2..0000000 --- a/.changeset/stupid-days-decide.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@hyperse/track": patch ---- - -perfect track pipeline diff --git a/.changeset/two-buckets-cheer.md b/.changeset/two-buckets-cheer.md deleted file mode 100644 index dbf67b8..0000000 --- a/.changeset/two-buckets-cheer.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"@hyperse/track-docs": patch -"@hyperse/track": patch ---- - -add docs website diff --git a/examples/next-example/README.md b/examples/next-example/README.md index 5ae7daf..9295c57 100644 --- a/examples/next-example/README.md +++ b/examples/next-example/README.md @@ -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: @@ -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. diff --git a/examples/next-example/package.json b/examples/next-example/package.json index d9a2117..3aff65c 100644 --- a/examples/next-example/package.json +++ b/examples/next-example/package.json @@ -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 .", diff --git a/website/docs/intro/live-example.md b/website/docs/intro/live-example.md index 3baba30..6d6fe1a 100644 --- a/website/docs/intro/live-example.md +++ b/website/docs/intro/live-example.md @@ -14,7 +14,7 @@ Read more in [**User guide > introducing**](/docs/intro/introducing) ::: - + ## Congratulations ! diff --git a/website/src/components/Stackblitz/index.tsx b/website/src/components/Stackblitz/index.tsx index de0d253..ab56265 100644 --- a/website/src/components/Stackblitz/index.tsx +++ b/website/src/components/Stackblitz/index.tsx @@ -1,6 +1,10 @@ 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 (