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
- MacOS or Linux system (untested with Bash on Windows)
24
-
-[Node.js](https://nodejs.org/en/)
25
-
- Gatsby CLI:
24
+
- MacOS or Linux system (untested with Bash on Windows)
25
+
-[Node.js](https://nodejs.org/en/)
26
+
- Gatsby CLI:
26
27
27
-
```bash
28
-
npm install -g gatsby-cli
29
-
```
28
+
```bash
29
+
npm install -g gatsby-cli
30
+
```
31
+
- Alternatively, you can use [Lando](https://docs.lando.dev). You can use Lando instead, to avoid installing Node.js and the Gatsby CLI on your local machine.
You can install directly on your host computer or via Lando. Both ways require the docs app to use a `GITHUB_API` token to operate.
52
58
We use the [gatsby-remark-embed-snippet](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-remark-embed-snippet) to use files from GitHub in our docs. Before you can build a local development site, you need to provide a GitHub token to the environment:
53
59
54
60
1. Log in to GitHub and go to <https://github.com/settings/tokens>
@@ -57,16 +63,26 @@ We use the [gatsby-remark-embed-snippet](https://github.com/gatsbyjs/gatsby/tree
57
63
1. Copy the token to your clipboard.
58
64
1. Create or edit `.env.development`, and add (replacing $TOKENHASH ):
59
65
60
-
```
61
-
GITHUB_API=$TOKENHASH
62
-
```
66
+
```bash
67
+
GITHUB_API=$TOKENHASH
68
+
```
63
69
64
70
### Run
65
71
66
-
```
72
+
```bash
67
73
cd documentation/
68
74
gatsby develop
69
75
```
76
+
You can view the local environment at `localhost:8000/`. Updates to docs are automatically refreshed in the browser.
77
+
78
+
79
+
#### Using Lando
80
+
81
+
Alternatively, you can use [Lando](https://gist.github.com/tormi/a8b8fc39f9481373b24dc94cb8d2ee31). The `lando start` command intiates the the app, installs node dependencies, and starts the `gatsby develop` server for you.
82
+
83
+
```bash
84
+
lando start
85
+
```
70
86
71
87
You can view the local environment at `localhost:8000/`. Updates to docs are automatically refreshed in the browser.
0 commit comments