File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 22
33This website is built using [ Docusaurus] ( https://docusaurus.io/ ) , a modern static website generator.
44
5- ### Installation
5+ ## Installation
66
7+ ``` bash
8+ yarn
79```
8- $ yarn
10+
11+ ## Local Development
12+
13+ 1 . ** Create `` .env `` file at the project root**
14+
15+ ``` bash
16+ echo > .env
917```
1018
11- ### Local Development
19+ 2 . ** Add environment variables to the `` .env `` file **
1220
21+ Open the `` .env `` file and define the variables from .env.example:
22+
23+ ``` text
24+ ALGOLIA_APP_ID=
25+ ALGOLIA_API_KEY=
26+ ALGOLIA_INDEX_NAME=
1327```
14- $ yarn start
28+
29+ 3 . ** Run Start Command**
30+
31+ ``` bash
32+ yarn start
1533```
1634
1735This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1836
19- ### Build
37+ ## Build
2038
21- ```
22- $ yarn build
39+ ``` bash
40+ yarn build
2341```
2442
2543This command generates static content into the ` build ` directory and can be served using any static contents hosting service.
2644
27- ### Deployment
45+ ## Deployment
2846
29- Using SSH:
47+ ** Using SSH:**
3048
31- ```
32- $ USE_SSH=true yarn deploy
49+ ``` bash
50+ USE_SSH=true yarn deploy
3351```
3452
35- Not using SSH:
53+ ** Not using SSH:**
3654
37- ```
38- $ GIT_USER=<Your GitHub username> yarn deploy
55+ ``` bash
56+ GIT_USER=< Your GitHub username> yarn deploy
3957```
4058
4159If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the ` gh-pages ` branch.
You can’t perform that action at this time.
0 commit comments