From a330f9b4ea77df9cd2fbceaddb0ff81fd211fe88 Mon Sep 17 00:00:00 2001 From: the-r3aper7 Date: Mon, 18 Sep 2023 18:53:14 +0530 Subject: [PATCH] added more docs --- .../docs/(qwik)/components/styles/index.mdx | 32 +++++++++++++++++++ .../docs/deployments/aws-lambda/index.mdx | 1 + .../docs/deployments/azure-swa/index.mdx | 25 +++++++++++++-- .../src/routes/docs/integrations/index.mdx | 12 ++----- .../src/routes/docs/integrations/nx/index.mdx | 2 ++ .../routes/docs/integrations/orama/index.mdx | 5 ++- .../docs/integrations/partytown/index.mdx | 8 ++--- 7 files changed, 68 insertions(+), 17 deletions(-) diff --git a/packages/docs/src/routes/docs/(qwik)/components/styles/index.mdx b/packages/docs/src/routes/docs/(qwik)/components/styles/index.mdx index fc58c2e95e2..4dce985bcb6 100644 --- a/packages/docs/src/routes/docs/(qwik)/components/styles/index.mdx +++ b/packages/docs/src/routes/docs/(qwik)/components/styles/index.mdx @@ -117,6 +117,11 @@ yarn run qwik add styled-vanilla-extract ```shell pnpm run qwik add styled-vanilla-extract +``` + + +```shell +bun run qwik add styled-vanilla-extract ``` @@ -144,6 +149,11 @@ yarn run qwik add styled-vanilla-extract ```shell pnpm run qwik add styled-vanilla-extract +``` + + +```shell +bun run qwik add styled-vanilla-extract ``` @@ -306,6 +316,18 @@ pnpm add -D less # .styl and .stylus pnpm add -D stylus +``` + + +```shell +# .scss and .sass +bun add -D sass + +# .less +bun add -D less + +# .styl and .stylus +bun add -D stylus ``` @@ -331,6 +353,11 @@ yarn run qwik add tailwind ```shell pnpm run qwik add tailwind +``` + + +```shell +bun run qwik add tailwind ``` @@ -356,6 +383,11 @@ yarn run qwik add postcss ```shell pnpm run qwik add postcss +``` + + +```shell +bun run qwik add postcss ``` diff --git a/packages/docs/src/routes/docs/deployments/aws-lambda/index.mdx b/packages/docs/src/routes/docs/deployments/aws-lambda/index.mdx index 7643c19e528..57d11efaa3b 100644 --- a/packages/docs/src/routes/docs/deployments/aws-lambda/index.mdx +++ b/packages/docs/src/routes/docs/deployments/aws-lambda/index.mdx @@ -9,6 +9,7 @@ import PackageManagerTabs from '~/components/package-manager-tabs/index.tsx'; # AWS Adapter +Qwik City AWS Adapter allows you to connect Qwik City to [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html?icmpid=docs_lambda_hel). ## Installation diff --git a/packages/docs/src/routes/docs/deployments/azure-swa/index.mdx b/packages/docs/src/routes/docs/deployments/azure-swa/index.mdx index 259e45cea08..643abd0b691 100644 --- a/packages/docs/src/routes/docs/deployments/azure-swa/index.mdx +++ b/packages/docs/src/routes/docs/deployments/azure-swa/index.mdx @@ -90,9 +90,28 @@ There are three ways to deploy: You can deploy your application from your local environment with: - ```shell - npx swa deploy - ``` + + +```shell +npx run deploy +``` + + +```shell +yarn run deploy +``` + + +```shell +pnpm run deploy +``` + + +```shell +bun run deploy +``` + + This will start a wizard which will guide you through login and deployment to Azure. diff --git a/packages/docs/src/routes/docs/integrations/index.mdx b/packages/docs/src/routes/docs/integrations/index.mdx index 4d0cafea07f..dd41b27ac82 100644 --- a/packages/docs/src/routes/docs/integrations/index.mdx +++ b/packages/docs/src/routes/docs/integrations/index.mdx @@ -23,31 +23,25 @@ Once you create a Qwik City application, run the following command to add new in ```shell -npm create qwik@latest npm run qwik add ``` ```shell -npm run qwik add -yarn create qwik@latest +yarn run qwik add ``` ```shell -pnpm create qwik@latest -npm run qwik add +pnpm run qwik add ``` ```shell -bun create qwik@latest -npm run qwik add +bun run qwik add ``` -```shell -``` It will prompt you to select the integration you want to add. Once you select an integration, it will be added to your application and you can start using it. diff --git a/packages/docs/src/routes/docs/integrations/nx/index.mdx b/packages/docs/src/routes/docs/integrations/nx/index.mdx index 80555c1a752..42c0a160264 100644 --- a/packages/docs/src/routes/docs/integrations/nx/index.mdx +++ b/packages/docs/src/routes/docs/integrations/nx/index.mdx @@ -5,6 +5,8 @@ contributors: - shairez --- +import PackageManagerTabs from '~/components/package-manager-tabs/index.tsx'; + # Nx and enterprise scale monorepos [Nx](https://nx.dev/) is a robust and extensible development platform designed to simplify the management diff --git a/packages/docs/src/routes/docs/integrations/orama/index.mdx b/packages/docs/src/routes/docs/integrations/orama/index.mdx index 7412c89dc17..37f331d2d85 100644 --- a/packages/docs/src/routes/docs/integrations/orama/index.mdx +++ b/packages/docs/src/routes/docs/integrations/orama/index.mdx @@ -13,7 +13,7 @@ import PackageManagerTabs from '~/components/package-manager-tabs/index.tsx'; Orama could be used in Qwik on the client side or on the server side with `routeLoader$`, `routeAction$` and `server$` functions. -The easiest way to add Orama to Qwik is using the `pnpm qwik add orama` command. This will install the required dependencies and create a new public route `/src/routes/orama` to showcase the Orama integration. +The easiest way to add Orama to Qwik is @@ -38,6 +38,9 @@ bun run qwik add orama +This will install the required dependencies and create a new public route `/src/routes/orama` to showcase the Orama integration. + + > Orama has been designed to work on any runtime and has no dependencies. A JavaScript runtime is the only requirement. For further reference, please check the [Orama documentation](https://docs.oramasearch.com/). \ No newline at end of file diff --git a/packages/docs/src/routes/docs/integrations/partytown/index.mdx b/packages/docs/src/routes/docs/integrations/partytown/index.mdx index 29504f8e9a1..d95f933f819 100644 --- a/packages/docs/src/routes/docs/integrations/partytown/index.mdx +++ b/packages/docs/src/routes/docs/integrations/partytown/index.mdx @@ -26,22 +26,22 @@ You can add Partytown easily by using the following Qwik starter script: ```shell -npm create qwik@latest +npm run qwik add partytown ``` ```shell -yarn create qwik@latest +yarn run qwik add partytown ``` ```shell -pnpm create qwik@latest +pnpm run qwik add partytown ``` ```shell -bun create qwik@latest +bun run qwik add partytown ```