You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ This repo is a “monorepo,” meaning it contains several projects in one. It c
38
38
39
39
### Setting up a development environment
40
40
41
-
You can [develop locally](#developing-locally) or use an online coding development environment like [GitHub Codespaces](#developing-using-github-codespaces)or [Gitpod](#developing-using-gitpod)to get started quickly.
41
+
You can [develop locally](#developing-locally) or use an online coding development environment like [GitHub Codespaces](#developing-using-github-codespaces) to get started quickly.
42
42
43
43
#### Developing locally
44
44
@@ -64,23 +64,24 @@ You can [develop locally](#developing-locally) or use an online coding developme
64
64
pnpm i
65
65
```
66
66
67
-
#### Developing using Gitpod
68
-
69
-
**Prerequisites:** Developing Starlight using Gitpod requires a free [Gitpod account](https://gitpod.io).
70
-
71
-
1.**Open the Gitpod URL**[https://gitpod.io/#https://github.com/withastro/starlight](https://gitpod.io/#https://github.com/withastro/starlight). You can alternatively install a [Gitpod browser extension](https://www.gitpod.io/docs/configure/user-settings/browser-extension) which will add a "Gitpod" button when viewing [Starlight's repo on GitHub](https://github.com/withastro/starlight).
72
-
73
-
2.**Install dependencies** with `pnpm`:
67
+
5.**Generate TypeScript types** for all Astro modules:
74
68
75
69
```sh
76
-
pnpm i
70
+
cd docs
71
+
pnpm astro sync
77
72
```
78
73
79
74
#### Developing using GitHub Codespaces
80
75
81
76
1.**Create a new codespace** via https://codespaces.new/withastro/starlight
82
77
83
-
2. If running the docs site, pass the `--host` flag to avoid “502 Bad Gateway” errors:
78
+
2.**Generate TypeScript types** for all Astro modules:
79
+
80
+
```sh
81
+
pnpm astro sync
82
+
```
83
+
84
+
3. If running the docs site, pass the `--host` flag to avoid “502 Bad Gateway” errors:
0 commit comments