Skip to content

Commit f770861

Browse files
committed
chore: update docs_src readme, gitignore.
1 parent 55e40d0 commit f770861

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,6 @@ docs_src/.vercel
6060

6161
# generated files
6262
docs_src/public/rss/
63+
64+
# env files
65+
*.env

docs_src/README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
1-
## Docs Base
1+
# Docs Base
22

33
This is the documentation website that will be used as a base for Robyn and Starfyre docs.
44

5-
## Setup
5+
## Environment Variables
6+
7+
To set the enviroment variables, you have to create a .env file in docs_src folder.
8+
9+
Here are some environment variables, you can set :
610

7-
1. Clone this repo
8-
2. Run `npm install`
9-
3. Run `npm run dev`
10-
4. Open `http://localhost:3000` in your browser
11+
- To provide search functionality by algolia (optional).
12+
- NEXT_PUBLIC_ALGOLIA_APP_ID
13+
- NEXT_PUBLIC_ALGOLIA_API_KEY
14+
- NEXT_PUBLIC_ALGOLIA_INDEX_NAME
15+
16+
## Setup
1117

18+
1. Clone [this repo](https://github.com/sparckles/Robyn)
19+
2. Run `cd Robyn\docs_src`
20+
3. Run `npm install`
21+
4. Run `npm run dev`
22+
5. Open [`http://localhost:3000`](http://localhost:3000) in your browser

0 commit comments

Comments
 (0)