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
Copy file name to clipboardExpand all lines: README.md
+37-1Lines changed: 37 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,5 +6,41 @@ This is the documentation repository for the [Casper Network](https://casper.net
6
6
7
7
The documentation site itself may be viewed at this address: https://docs.casper.network/.
8
8
9
-
For instructions on how to build, run, edit and contribute to this documentation please refer to the [developer documentation](./README/INDEX.md).
9
+
For instructions on how to build, run, edit and contribute to this documentation, please refer to the [developer documentation](./README/INDEX.md).
10
10
11
+
**Important Note: A complete rework of the documentation is currently underway. While fixes and improvements to this legacy version are welcome, please avoid making major or structural changes.**
12
+
13
+
## Quick Local Run Instructions
14
+
15
+
To run the documentation site locally, follow these steps:
Create a file named `.env`in the root of the `docs-redux` directory with the following content:
27
+
28
+
```
29
+
URL=http://localhost:3000
30
+
BASE_URL=/
31
+
ALGOLIA_APP_ID=your_algolia_app_id
32
+
ALGOLIA_INDEX_NAME=your_algolia_index_name
33
+
ALGOLIA_API_KEY=your_algolia_api_key
34
+
```
35
+
36
+
*(Note: Replace `your_algolia_app_id`, `your_algolia_index_name`, and `your_algolia_api_key` with actual values if you intend to use Algolia search; otherwise, placeholders are sufficient forlocal development.)*
37
+
38
+
3. **Install dependencies, build, and serve:**
39
+
40
+
```bash
41
+
npm install
42
+
npm run build
43
+
npm run serve
44
+
```
45
+
46
+
This will install the necessary packages, build the static site, and start a local server. You can then access the documentation in your browser at `http://localhost:3000/`.
0 commit comments