From 973d1076bf63b0e9fb5418efe524ccdde118a880 Mon Sep 17 00:00:00 2001 From: Sarah Rainsberger Date: Tue, 6 Jun 2023 16:36:34 -0300 Subject: [docs] adds updating Starlight integration (#164) Co-authored-by: Chris Swithinbank --- docs/src/content/docs/getting-started.mdx | 37 +++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) 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: + + + + +```sh +# upgrade Starlight with npm +npm install @astrojs/starlight@latest +``` + + + + +```sh +# upgrade Starlight with pnpm +pnpm upgrade @astrojs/starlight --latest +``` + + + + +```sh +# upgrade Starlight with yarn +yarn upgrade @astrojs/starlight --latest +``` + + + + +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). -- cgit