From fe763dd235ed338ac6025b565c07bab250bc79e7 Mon Sep 17 00:00:00 2001 From: Luiz Ferraz Date: Sun, 11 Feb 2024 08:09:48 -0300 Subject: [PATCH] docs: document plugins used for each utility (#49) --- docs/src/content/docs/utilities/add-dts.mdx | 4 +++- docs/src/content/docs/utilities/add-virtual-import.mdx | 4 +++- docs/src/content/docs/utilities/add-vite-plugin.mdx | 4 +++- docs/src/content/docs/utilities/has-integration.mdx | 4 +++- docs/src/content/docs/utilities/watch-integration.mdx | 6 ++++-- 5 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/src/content/docs/utilities/add-dts.mdx b/docs/src/content/docs/utilities/add-dts.mdx index 051b5f9a..0b8135bd 100644 --- a/docs/src/content/docs/utilities/add-dts.mdx +++ b/docs/src/content/docs/utilities/add-dts.mdx @@ -9,11 +9,13 @@ create a file inside `.astro` and reference it from `src/env.d.ts`. For example: - ```ts title="my-integration/index.ts" "addDts" + ```ts title="my-integration/index.ts" /addDts\\b/ {2,6} import { defineIntegration } from "astro-integration-kit"; + import { addDtsPlugin } from "astro-integration-kit/plugins"; export default defineIntegration({ name: "my-integration", + plugins: [addDtsPlugin], setup(options) { return { "astro:config:setup": ({ addDts }) => { diff --git a/docs/src/content/docs/utilities/add-virtual-import.mdx b/docs/src/content/docs/utilities/add-virtual-import.mdx index 2f106ee8..8d99580f 100644 --- a/docs/src/content/docs/utilities/add-virtual-import.mdx +++ b/docs/src/content/docs/utilities/add-virtual-import.mdx @@ -8,11 +8,13 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'; - ```ts title="my-integration/index.ts" "addVirtualImport" + ```ts title="my-integration/index.ts" /addVirtualImport\\b/ {2,6} import { defineIntegration } from "astro-integration-kit"; + import { addVirtualImportPlugin } from "astro-integration-kit/plugins"; export default defineIntegration({ name: "my-integration", + plugins: [addVirtualImportPlugin], setup() { return { "astro:config:setup": ({ addVirtualImport }) => { diff --git a/docs/src/content/docs/utilities/add-vite-plugin.mdx b/docs/src/content/docs/utilities/add-vite-plugin.mdx index e3af7f7c..7a40874e 100644 --- a/docs/src/content/docs/utilities/add-vite-plugin.mdx +++ b/docs/src/content/docs/utilities/add-vite-plugin.mdx @@ -9,12 +9,14 @@ to the Astro config. For example: - ```ts title="my-integration/index.ts" "addVitePlugin" + ```ts title="my-integration/index.ts" /addVitePlugin\\b/ {2,7} import { defineIntegration } from "astro-integration-kit"; + import { addVitePluginPlugin } from "astro-integration-kit/plugins"; import { VitePWA } from 'vite-plugin-pwa' export default defineIntegration({ name: "my-integration", + plugins: [addVitePluginPlugin], setup(options) { return { "astro:config:setup": ({ addVitePlugin }) => { diff --git a/docs/src/content/docs/utilities/has-integration.mdx b/docs/src/content/docs/utilities/has-integration.mdx index c2e0703e..d937e20b 100644 --- a/docs/src/content/docs/utilities/has-integration.mdx +++ b/docs/src/content/docs/utilities/has-integration.mdx @@ -8,11 +8,13 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'; - ```ts title="my-integration/index.ts" "hasIntegration" + ```ts title="my-integration/index.ts" /hasIntegration\\b/ {2,6} import { defineIntegration } from "astro-integration-kit"; + import { hasIntegrationPlugin } from "astro-integration-kit/plugins"; export default defineIntegration({ name: "my-integration", + plugins: [hasIntegrationPlugin], setup() { return { "astro:config:setup": ({ hasIntegration, logger }) => { diff --git a/docs/src/content/docs/utilities/watch-integration.mdx b/docs/src/content/docs/utilities/watch-integration.mdx index dd0f69ce..d755f9ea 100644 --- a/docs/src/content/docs/utilities/watch-integration.mdx +++ b/docs/src/content/docs/utilities/watch-integration.mdx @@ -9,11 +9,13 @@ the integration directory has changed. For example: - ```ts title="my-integration/index.ts" "watchIntegration" + ```ts title="my-integration/index.ts" /watchIntegration\\b/ {2,6} import { createResolver, defineIntegration } from "astro-integration-kit"; + import { watchIntegrationPlugin } from "astro-integration-kit/plugins"; export default defineIntegration({ name: "my-integration", + plugins: [watchIntegrationPlugin], setup() { const { resolve } = createResolver(import.meta.url); @@ -50,4 +52,4 @@ the integration directory has changed. For example: } ``` - \ No newline at end of file +