Skip to content

Commit 2f67e44

Browse files
author
Alban Bailly
committed
update README
1 parent 6ad7483 commit 2f67e44

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,19 @@ 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/
1414

15+
If you'd like to use a local YAML file to build the API docs, run:
16+
17+
`yarn develop [relative-path-to-your-local-YAML-file]`
18+
19+
ex: `yarn develop ../linode-api-docs/openapi.yaml`
20+
1521
### Build
1622

1723
The API documentation in this site is also indexed in Algolia, so that
1824
it can be searched across Linode's services. The scripts for this are
1925
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
26+
you will need to create a `.env` file in the root directory with the
2127
following values:
2228

2329
ALGOLIA_API_KEY=(your key here)
24-
ALGOLIA_API_SECRET=(your secret here)
30+
ALGOLIA_API_SECRET=(your secret here)

0 commit comments

Comments
 (0)