From 8e6ff2feea6dfb8ac27002a90737671ce8478317 Mon Sep 17 00:00:00 2001 From: Eduardo Pereira Date: Wed, 1 May 2024 00:08:51 -0300 Subject: [PATCH] Add Steps component to `github.mdx` --- src/content/docs/en/guides/deploy/github.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/content/docs/en/guides/deploy/github.mdx b/src/content/docs/en/guides/deploy/github.mdx index 148bd42d3f090..c39a8fe875068 100644 --- a/src/content/docs/en/guides/deploy/github.mdx +++ b/src/content/docs/en/guides/deploy/github.mdx @@ -4,6 +4,7 @@ description: How to deploy your Astro site to the web using GitHub Pages. type: deploy i18nReady: true --- +import { Steps } from '@astrojs/starlight/components'; You can use [GitHub Pages](https://pages.github.com/) to host an Astro website directly from a repository on [GitHub.com](https://github.com/). @@ -35,7 +36,6 @@ The value for `site` must be one of the following: - The following URL based on your username: `https://.github.io` - The random URL autogenerated for a [GitHub Organization's private page](https://docs.github.com/en/enterprise-cloud@latest/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site): `https://.pages.github.io/` - #### `base` A value for `base` may be required so that Astro will treat your repository name (e.g. `/my-repo`) as the root of your website. @@ -83,6 +83,7 @@ export default defineConfig({ ## Configure a GitHub Action + 1. Create a new file in your project at `.github/workflows/deploy.yml` and paste in the YAML below. ```yaml title="deploy.yml" @@ -140,6 +141,6 @@ export default defineConfig({ 3. Choose **GitHub Actions** as the **Source** of your site. 4. Commit the new workflow file and push it to GitHub. - + Your site should now be published! When you push changes to your Astro project’s repository, the GitHub Action will automatically deploy them for you.