From fe4a48c10b47fe9577e1f35ebc59b76ef3d4cacb Mon Sep 17 00:00:00 2001 From: iitzIrFan Date: Fri, 27 Dec 2024 22:45:55 +0530 Subject: [PATCH 1/4] Update URL paths to use dynamic menu structure via useContent hook & also updated the package.json files dev scipts that caused error on windows machine while setting up project locally ! --- package.json | 2 +- packages/docs/package.json | 2 +- packages/docs/src/routes/docs/menu.md | 71 ++++++++++++++------------- 3 files changed, 39 insertions(+), 36 deletions(-) diff --git a/package.json b/package.json index acaa9ad1c06..8c09b0762ca 100644 --- a/package.json +++ b/package.json @@ -214,7 +214,7 @@ "cli.qwik": "pnpm build.cli && node packages/qwik/dist/qwik-cli.cjs", "cli.validate": "tsx --require ./scripts/runBefore.ts scripts/validate-cli.ts", "deps": "corepack pnpm upgrade -i -r --latest && syncpack fix-mismatches && corepack pnpm dedupe", - "docs.dev": "cd packages/docs && pnpm build.repl-sw && pnpm dev", + "docs.dev": "concurrently \"cd packages/docs && pnpm build.repl-sw\" \"cd packages/docs && pnpm dev\"", "docs.preview": "cd packages/docs && pnpm preview", "docs.sync": "tsx --require ./scripts/runBefore.ts scripts/docs_sync/index.ts && pnpm fmt", "eslint.update": "tsx --require ./scripts/runBefore.ts scripts/eslint-docs.ts", diff --git a/packages/docs/package.json b/packages/docs/package.json index 991781fc063..2bbca867df6 100644 --- a/packages/docs/package.json +++ b/packages/docs/package.json @@ -76,7 +76,7 @@ "codesandbox.sync": "tsx codesandbox.sync.ts", "contributors": "tsx contributors.ts", "deploy": "wrangler pages publish ./dist", - "dev": "tsx check-qwik-build.ts && vite --mode ssr --open", + "dev": "concurrently \"tsx check-qwik-build.ts\" \"vite --mode ssr --open\"", "dev.debug": "node --inspect-brk ../../node_modules/vite/bin/vite.js --mode ssr --force", "prebuild.core": "tsx check-qwik-build.ts", "preview": "qwik build preview && vite preview --open", diff --git a/packages/docs/src/routes/docs/menu.md b/packages/docs/src/routes/docs/menu.md index 194e8f47cf8..b8bae4afb95 100644 --- a/packages/docs/src/routes/docs/menu.md +++ b/packages/docs/src/routes/docs/menu.md @@ -1,6 +1,6 @@ # Qwik Guide -## Introduction +## Qwik Group - [Overview]() - [Getting Started]() @@ -16,10 +16,29 @@ - [Context]() - [Slots]() - [Rendering]() -- [Styling]() +- [Styling][def] - [API Reference]() -## Qwik City +## Concepts + +- [Think Qwik]() +- [Resumable]() +- [Progressive]() +- [Reactivity]() + +## Qwik Advanced + +- [The $ dollar sign]() +- [Containers]() +- [QRL]() +- [Library mode]() +- [Qwikloader]() +- [Optimizer]() +- [Modules Prefetching]() +- [Build Directory]() +- [Vite]() + +## QwikCity - [Overview]() - [Routing]() @@ -31,11 +50,21 @@ - [Endpoints]() - [Middleware]() - [server$]() -- [Re-exporting loaders](/docs/(qwikcity)/re-exporting-loaders/index.mdx) +- [Re-exporting loaders](/docs/(qwikcity)/re-exporting-loaders/index.mdx>) - [Caching]() - [HTML attributes]() - [API reference]() +## QwikCity Advanced + +- [Content Security Policy]() +- [Menus]() +- [Request Handling]() +- [Advanced Routing]() +- [Sitemaps]() +- [Speculative Module Fetching]() +- [Static Assets]() + ## Cookbook - [Overview](/docs/cookbook/index.mdx) @@ -109,35 +138,6 @@ - [Bundle Optimization]() - [Env variables]() -## Concepts - -- [Think Qwik]() -- [Resumable]() -- [Progressive]() -- [Reactivity]() - -## Advanced - -- [The $ dollar sign]() -- [Containers]() -- [QRL]() -- [Library mode]() -- [Qwikloader]() -- [Optimizer]() -- [Modules Prefetching]() -- [Build Directory]() -- [Vite]() -- [Advanced Routing]() -- [Qwik Plugins]() -- [Request Handling]() -- [Speculative Module Fetching]() -- [Menus]() -- [Static Assets]() -- [Sitemaps]() -- [ESLint-Rules]() -- [Content Security Policy]() -- [Complex Forms]() - ## Reference - [API Reference](/api/) @@ -149,7 +149,7 @@ - [Insights](/docs/labs/insights/index.mdx) - [Typed Routes](/docs/labs/typed-routes/index.mdx) - [Devtools](/docs/labs/devtools/index.mdx) -- [usePreventNavigate](/docs/labs/usePreventNavigate/index.mdx) +- [usePreventNavigate](/docs/labs/usePreventNavigate/index.mdx>) ## Community @@ -158,3 +158,6 @@ - [Discord](https://qwik.dev/chat) - [Community Projects](/community/projects/index.mdx) - [Values](/community/values/index.mdx) + + +[def]: \ No newline at end of file From 9ce4d8b3c23ff9dc9f9f16a9edd2cf91e6bc4f04 Mon Sep 17 00:00:00 2001 From: iitzIrFan Date: Sat, 28 Dec 2024 23:29:41 +0530 Subject: [PATCH 2/4] Updates as per the requirements mentioned ! --- packages/docs/src/routes/docs/menu.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/packages/docs/src/routes/docs/menu.md b/packages/docs/src/routes/docs/menu.md index b8bae4afb95..7816a52086b 100644 --- a/packages/docs/src/routes/docs/menu.md +++ b/packages/docs/src/routes/docs/menu.md @@ -1,5 +1,5 @@ # Qwik Guide - +## Introduction ## Qwik Group - [Overview]() @@ -16,7 +16,7 @@ - [Context]() - [Slots]() - [Rendering]() -- [Styling][def] +- [Styling]() - [API Reference]() ## Concepts @@ -50,7 +50,7 @@ - [Endpoints]() - [Middleware]() - [server$]() -- [Re-exporting loaders](/docs/(qwikcity)/re-exporting-loaders/index.mdx>) +- [Re-exporting loaders]() - [Caching]() - [HTML attributes]() - [API reference]() @@ -149,7 +149,7 @@ - [Insights](/docs/labs/insights/index.mdx) - [Typed Routes](/docs/labs/typed-routes/index.mdx) - [Devtools](/docs/labs/devtools/index.mdx) -- [usePreventNavigate](/docs/labs/usePreventNavigate/index.mdx>) +- [usePreventNavigate]() ## Community @@ -158,6 +158,3 @@ - [Discord](https://qwik.dev/chat) - [Community Projects](/community/projects/index.mdx) - [Values](/community/values/index.mdx) - - -[def]: \ No newline at end of file From b7c1f049f9df9eca6680be5aad15b96b17b62765 Mon Sep 17 00:00:00 2001 From: iitzIrFan Date: Sun, 29 Dec 2024 23:07:34 +0530 Subject: [PATCH 3/4] package.json will updated to previous and insecting why it dosen't work on Windows OS --- packages/docs/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/package.json b/packages/docs/package.json index 2bbca867df6..991781fc063 100644 --- a/packages/docs/package.json +++ b/packages/docs/package.json @@ -76,7 +76,7 @@ "codesandbox.sync": "tsx codesandbox.sync.ts", "contributors": "tsx contributors.ts", "deploy": "wrangler pages publish ./dist", - "dev": "concurrently \"tsx check-qwik-build.ts\" \"vite --mode ssr --open\"", + "dev": "tsx check-qwik-build.ts && vite --mode ssr --open", "dev.debug": "node --inspect-brk ../../node_modules/vite/bin/vite.js --mode ssr --force", "prebuild.core": "tsx check-qwik-build.ts", "preview": "qwik build preview && vite preview --open", From eb652592e100499929a197d33504caa337d4d61d Mon Sep 17 00:00:00 2001 From: iitzIrFan Date: Thu, 2 Jan 2025 02:50:23 +0530 Subject: [PATCH 4/4] dev script optimized for both UNIX based & Windows based machines --- packages/docs/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/package.json b/packages/docs/package.json index 991781fc063..501fd7b8610 100644 --- a/packages/docs/package.json +++ b/packages/docs/package.json @@ -76,7 +76,7 @@ "codesandbox.sync": "tsx codesandbox.sync.ts", "contributors": "tsx contributors.ts", "deploy": "wrangler pages publish ./dist", - "dev": "tsx check-qwik-build.ts && vite --mode ssr --open", + "dev": "concurrently \"cross-env tsx check-qwik-build.ts\" \"vite --mode ssr --open\"", "dev.debug": "node --inspect-brk ../../node_modules/vite/bin/vite.js --mode ssr --force", "prebuild.core": "tsx check-qwik-build.ts", "preview": "qwik build preview && vite preview --open",