Skip to content

Commit 2a7890b

Browse files
committed
Add to build scripts and include documentation in README
1 parent 1dbb766 commit 2a7890b

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ The developers.linode.com website built with Gatsby and including the API Docs
88

99
`yarn develop`
1010

11-
you may need to install the gastby CLI as well `npm install -g gatsby-cli`
11+
you may need to install the Gatsby CLI as well `npm install -g gatsby-cli`
1212

1313
Check out the site at http://localhost:8000/
14+
15+
### Build
16+
17+
The API documentation in this site is also indexed in Algolia, so that
18+
it can be searched across Linode's services. The scripts for this are
19+
located in the `/search` directory. In order to run them correctly,
20+
you will need to create a `.env` file in the root directory with the
21+
following values:
22+
23+
ALGOLIA_API_KEY=(your key here)
24+
ALGOLIA_API_SECRET=(your secret here)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
],
4242
"license": "MIT",
4343
"scripts": {
44-
"build": "./getBaseTheme.sh && gatsby build",
44+
"build": "./getBaseTheme.sh && gatsby build && node search/buildIndex.js",
4545
"develop": "./getBaseTheme.sh && gatsby develop",
4646
"start": "npm run develop",
4747
"serve": "gatsby serve",

0 commit comments

Comments
 (0)