summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSarah Rainsberger2023-06-06 16:36:34 -0300
committerGitHub2023-06-06 16:36:34 -0300
commit973d1076bf63b0e9fb5418efe524ccdde118a880 (patch)
tree2d7342075adf68d6af6340daf28b5cb27f032103
parent308e851f3ee649420b47f70789a1793d70452f65 (diff)
downloadIT.starlight-973d1076bf63b0e9fb5418efe524ccdde118a880.tar.gz
IT.starlight-973d1076bf63b0e9fb5418efe524ccdde118a880.tar.bz2
IT.starlight-973d1076bf63b0e9fb5418efe524ccdde118a880.zip
[docs] adds updating Starlight integration (#164)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
-rw-r--r--docs/src/content/docs/getting-started.mdx37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/src/content/docs/getting-started.mdx b/docs/src/content/docs/getting-started.mdx
index f50f2547..1dc224c1 100644
--- a/docs/src/content/docs/getting-started.mdx
+++ b/docs/src/content/docs/getting-started.mdx
@@ -85,3 +85,40 @@ If you forget anything important, Starlight will let you know.
Once you have created and customized your Starlight website, you can deploy it to a web server or hosting platform of your choice including Netlify, Vercel, GitHub Pages and many more.
[Learn about deploying an Astro site in the Astro docs.](https://docs.astro.build/en/guides/deploy/)
+
+## Updating Starlight
+
+:::tip
+Because Starlight is beta software, there will be frequent updates and improvements. Be sure to update Starlight regularly!
+:::
+
+Starlight is an Astro integration, and is updated like any `@astrojs/*` integration:
+
+<Tabs>
+<TabItem label="npm">
+
+```sh
+# upgrade Starlight with npm
+npm install @astrojs/starlight@latest
+```
+
+</TabItem>
+<TabItem label="pnpm">
+
+```sh
+# upgrade Starlight with pnpm
+pnpm upgrade @astrojs/starlight --latest
+```
+
+</TabItem>
+<TabItem label="Yarn">
+
+```sh
+# upgrade Starlight with yarn
+yarn upgrade @astrojs/starlight --latest
+```
+
+</TabItem>
+</Tabs>
+
+You can see a full list of the changes made in each release in [the Starlight changelog](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md).