summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Matthew Phillips <matthew@matthewphillips.info> 2021-06-01 19:45:31 -0400
committerGravatar GitHub <noreply@github.com> 2021-06-01 18:45:31 -0500
commitee5b1ac12f60f1c0265d395d742dd8e1db880411 (patch)
treeed77d86b1f238b9ef3055b6b03adb4a9a3a393b5
parent00c6dec8eb33d2125ec86fe2fb32dee4cf5c9ead (diff)
downloadastro-ee5b1ac12f60f1c0265d395d742dd8e1db880411.tar.gz
astro-ee5b1ac12f60f1c0265d395d742dd8e1db880411.tar.zst
astro-ee5b1ac12f60f1c0265d395d742dd8e1db880411.zip
Link to the snowpack config docs (#287)
* Link to the snowpack config docs Updates the config section to let people know they can configure Snowpack and links to the docs. * chore: update to `snowpack.config.mjs` Co-authored-by: Nate Moore <nate@skypack.dev>
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0600a0544..fa71a5b29 100644
--- a/README.md
+++ b/README.md
@@ -174,8 +174,14 @@ Astro will automatically create a `/sitemap.xml` for you for SEO! Be sure to set
## ⚙️ Config
+Configuration for Astro is done through the `astro.config.mjs` file at the root of your project. To learn more:
+
👉 [**`astro.config.mjs` Reference**][docs-config]
+Astro uses __[Snowpack](https://www.snowpack.dev/)__ for module resolution. You can configure Snowpack by adding a `snowpack.config.mjs` file in the root of your project. You might need this to add loader plugins, for example. To learn more:
+
+👉 [**`snowpack.config.mjs` Reference**][docs-snowpack-config]
+
## 📚 API
👉 [**Full API Reference**][docs-api]
@@ -189,6 +195,7 @@ Astro will automatically create a `/sitemap.xml` for you for SEO! Be sure to set
👉 [**Dev Server Docs**][docs-dev]
[docs-config]: ./docs/config.md
+[docs-snowpack-config]: https://www.snowpack.dev/reference/configuration
[docs-syntax]: ./docs/syntax.md
[docs-api]: ./docs/api.md
[docs-collections]: ./docs/collections.md