docs: document plugins used for each utility (#49)

florian-lefebvre · Feb 11, 2024 · fe763dd · fe763dd
1 parent 2c33c1a
commit fe763dd
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 6 deletions.
diff --git 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:
 
 <Tabs>
     <TabItem label="Extended hooks">
-    ```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
@@ -8,11 +8,13 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
 
 <Tabs>
     <TabItem label="Extended hooks">
-    ```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
@@ -9,12 +9,14 @@ to the Astro config. For example:
 
 <Tabs>
     <TabItem label="Extended hooks">
-    ```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
@@ -8,11 +8,13 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
 
 <Tabs>
 	<TabItem label="Extended hooks">
-	```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
@@ -9,11 +9,13 @@ the integration directory has changed. For example:
 
 <Tabs>
     <TabItem label="Extended hooks">
-	```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:
 	}
 	``` 
 	</TabItem>
-</Tabs>
+</Tabs>