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
+12-22
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@
14
14
We now use [lychee-broken-link-checker](https://github.com/marketplace/actions/lychee-broken-link-checker) to check for broken links in the GitHub Markdown. We use a corresponding link checker for pages on Aptos.dev.
You may have to run the following command first if you are on macOS M1 Sonoma or newer
47
+
You may have to run the following command first if you are on macOS M1 Sonoma or newer:
48
48
49
49
```sh
50
50
pnpm add node-gyp -g
51
51
```
52
52
53
+
Then, run:
54
+
53
55
```sh
54
56
pnpm install
55
57
```
@@ -58,34 +60,22 @@ pnpm install
58
60
59
61
> Note: PLEASE SEE `apps/nextra/README.md` for more details!
60
62
61
-
0. Setup environment
63
+
1. Setup environment
62
64
63
65
Ensure you have configured your `.env` properly under `apps/nextra/.env`. There is a `.env.example` there that you can duplicate and rename to `.env` for simplicity.
64
66
65
-
To ensure you have the right setup, you can run
66
-
67
-
```sh
68
-
pnpm prebuild
69
-
```
70
-
71
-
1. Build Nextra
67
+
2. Build Nextra
72
68
73
69
```bash
74
-
npx turbo run build --filter={apps/nextra}...
70
+
pnpm run build
75
71
```
76
72
77
73
This will build `apps/nextra` and all local packages it depends on.
78
74
79
-
2. Navigate to the correct subdirectory
80
-
81
-
```sh
82
-
cd apps/nextra
83
-
```
84
-
85
75
3. Run the development server
86
76
87
77
```sh
88
-
pnpm dev
78
+
pnpm run dev
89
79
```
90
80
91
81
## Debugging
@@ -98,9 +88,9 @@ pnpm fmt
98
88
99
89
## Regenerating contributors
100
90
101
-
The src/contributors.json file (which powers the list of Authors at the bottom of doc pages) needs to be manually generated.
91
+
The `src/contributors.json` file (which powers the list of Authors at the bottom of doc pages) needs to be manually generated.
102
92
103
-
In order to generate the contributor map you must authenticate with GitHub. The best way to do that is using GitHub CLI [installation guide](https://github.com/cli/cli#installation). Once you have the GitHub CLI installed, you can run the following command to authenticate:
93
+
In order to generate the contributor map, you must authenticate with GitHub. The best way to do that is using GitHub CLI [installation guide](https://github.com/cli/cli#installation). Once you have the GitHub CLI installed, you can run the following command to authenticate:
104
94
105
95
```sh
106
96
gh auth login --scopes read:user,user:email
@@ -110,4 +100,4 @@ Once that is done, you can generate the map with this command:
0 commit comments