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
- Alternatively, you can use [Lando](https://docs.lando.dev). Use Lando to bypass installing Node.js and the Gatsby CLI on your local machine. Lando requires a Docker version in the `2.1.0.0` - `3.1.99` range.
35
36
36
-
### Get the Code
37
+
#### Mac Steps
37
38
38
-
Fork and clone this repository.
39
+
This list of steps should work on a Mac with [Homebrew](https://brew.sh/):
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.
61
59
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:
62
60
63
61
1. Log in to GitHub and go to <https://github.com/settings/tokens>
64
-
1. Click Generate new token
65
-
1. Give the token a name and click the **public_repo** checkbox, then the Generate Token button at the bottom
66
-
1. Copy the token to your clipboard.
67
-
1. Create or edit `.env.development`, and add (replacing `$TOKENHASH` ):
62
+
1. Click **Generate new token**
63
+
1. Give the token a name and click the **public_repo** checkbox, then the **Generate Token** button at the bottom
64
+
1. Copy the token to your clipboard
65
+
1. In the root `documentation` directory, create a new file called `.env.development` and add (replacing `$TOKENHASH` ):
68
66
69
67
```bash
70
68
GITHUB_API=$TOKENHASH
71
69
```
72
70
71
+
## Install With The Gatsby Cli
72
+
73
+
From the `documentation` directory:
74
+
75
+
```bash
76
+
npm ci
77
+
```
78
+
73
79
### Run
74
80
81
+
Still in the `documentation` directory:
82
+
75
83
```bash
76
-
cd documentation/
77
-
gatsby develop
84
+
npm run develop
78
85
```
79
-
You can view the local environment at `localhost:8000/`. Updates to docs are automatically refreshed in the browser.
80
86
87
+
Use your local browser to navigate to `localhost:8000/`.
88
+
89
+
Locally saved updates to docs are automatically refreshed in the browser.
81
90
82
-
#### Using Lando
91
+
## Install With Lando
83
92
84
93
Alternatively, you can use [Lando](https://gist.github.com/tormi/a8b8fc39f9481373b24dc94cb8d2ee31). The `lando start`command initiates the app, installs node dependencies, and starts the `gatsby develop` server for you:
85
94
@@ -89,12 +98,10 @@ lando start
89
98
90
99
You can view the local environment at `localhost:8000/`. Updates to docs are automatically refreshed in the browser.
91
100
92
-
93
101
## Testing
94
102
95
103
We include several tools to test that new content doesn't break the documentation. Most of these tests are performed automatically by our continuous integration service, but pull requests created from external contributors aren't included in CI tests. If you want to manually test your branch, you can execute the following tests within the Docker container.
96
104
97
105
### Merge Conflicts
98
106
99
107
To check for merge conflict messages accidentally committed into the docs, run `merge_conflicts.sh` from `scripts`.
0 commit comments