diff --git a/docs/pages/tutorials/integrating-with-astro.md b/docs/pages/tutorials/integrating-with-astro.md index 186e46eb..fcc3e795 100644 --- a/docs/pages/tutorials/integrating-with-astro.md +++ b/docs/pages/tutorials/integrating-with-astro.md @@ -11,11 +11,13 @@ This page explains how to integrate Shoelace with an Astro app. :::tip This is a community-maintained document. Please [ask the community](/resources/community) if you have questions about this integration. You can also [suggest improvements](https://github.com/shoelace-style/shoelace/blob/next/docs/tutorials/integrating-with-astro.md) to make it better. ::: + ## SSR and client scripts In the following tutorial you will notice that Shoelace cannot be imported in the frontmatter of Astro files. This is because Shoelace relies on globals from the DOM to be present. There is a [Lit + Astro integration for SSR](https://docs.astro.build/en/guides/integrations-guide/lit/) , however it will not work with Shoelace in its current state due to some reliance on DOM APIs that aren't shimmed. We are working to resolve this. + ## Instructions - Astro 4.11.3 - Node: v18.17.1 or v20.3.0 or higher. ( v19 is not supported.) @@ -28,8 +30,6 @@ To get started using Shoelace with Astro, the following packages must be install npm install @shoelace-style/shoelace rollup-plugin-copy ``` - - ### Importing components In `/src/pages/index.astro`, set the base path and import Shoelace. @@ -48,13 +48,12 @@ import "@shoelace-style/shoelace/dist/themes/light.css"; - ``` :::tip @@ -83,25 +82,25 @@ setBasePath("dist/assets"); - ``` + ## Modifying Astro Config You'll notice the above steps never added our icons into our `/public` directory. To solve this, we can install `rollup-plugin-copy` to copy Shoelace's assets into your public directory. @@ -112,7 +111,7 @@ Here's what your Astro config should look like: // astro.config.mjs import { defineConfig } from 'astro/config'; -import copy from 'rollup-plugin-copy' +import copy from 'rollup-plugin-copy'; // https://astro.build/config export default defineConfig({ @@ -121,11 +120,12 @@ export default defineConfig({ copy({ // Copy only on first build. We dont want to trigger additional server reloads. copyOnce: true, - hook: "buildStart", + hook: 'buildStart', targets: [ - { src: 'node_modules/@shoelace-style/shoelace/dist/assets/*', dest: 'public/shoelace-assets/assets/' }, + { src: 'node_modules/@shoelace-style/shoelace/dist/assets/*', dest: 'public/shoelace-assets/assets/' } ] }) ] } }); +```