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
Fix broken link and update installation instructions
- Fixed invalid GitHub actions URL by removing extra slash.
- Improved clarity in the setup steps.
- Minor formatting adjustments for better readability.
Copy file name to clipboardExpand all lines: README.md
+13-11Lines changed: 13 additions & 11 deletions
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,31 +60,31 @@ 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
67
+
To ensure you have the right setup, you can run:
66
68
67
69
```sh
68
70
pnpm prebuild
69
71
```
70
72
71
-
1. Build Nextra
73
+
2. Build Nextra
72
74
73
75
```bash
74
76
npx turbo run build --filter={apps/nextra}...
75
77
```
76
78
77
79
This will build `apps/nextra` and all local packages it depends on.
78
80
79
-
2. Navigate to the correct subdirectory
81
+
3. Navigate to the correct subdirectory
80
82
81
83
```sh
82
84
cd apps/nextra
83
85
```
84
86
85
-
3. Run the development server
87
+
4. Run the development server
86
88
87
89
```sh
88
90
pnpm dev
@@ -98,9 +100,9 @@ pnpm fmt
98
100
99
101
## Regenerating contributors
100
102
101
-
The src/contributors.json file (which powers the list of Authors at the bottom of doc pages) needs to be manually generated.
103
+
The `src/contributors.json` file (which powers the list of Authors at the bottom of doc pages) needs to be manually generated.
102
104
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:
105
+
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
106
105
107
```sh
106
108
gh auth login --scopes read:user,user:email
@@ -110,4 +112,4 @@ Once that is done, you can generate the map with this command:
0 commit comments