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
This step will configure the Docusaurus static site generator.
53
-
54
-
2. Start the server locally. This will also open the locally built docs in your default browser.
52
+
2. Build the repository
55
53
56
-
> **NOTE**: This step will not generate static html files, but will render the docs dynamically.
57
-
58
-
```
59
-
pnpm start
54
+
```sh
55
+
pnpm build
60
56
```
61
57
62
-
3. See your changes staged at: http://localhost:3000/
63
-
64
-
4. Create a pull request with your changes as described in our [Contributing](https://github.com/aptos-labs/aptos-core/blob/main/CONTRIBUTING.md) README.
65
-
66
-
## (Optional) Build static html files
67
-
68
-
Execute the below steps if you want to generate static html documentation files. A `build` directory will be created with the static html files and assets contained in it.
58
+
3. Navigate to the correct subdirectory
69
59
70
-
1. Make sure you install dependencies.
71
-
72
-
```
73
-
pnpm install
60
+
**Docusaurus**
61
+
```sh
62
+
cd apps/docusaurus
74
63
```
75
64
76
-
2. Build static html files with pnpm.
77
-
78
-
```
79
-
pnpm build
65
+
**Nextra**
66
+
```sh
67
+
cd apps/nextra
80
68
```
81
69
82
-
This command generates static html content and places it in the `build` directory.
83
-
84
-
3. Finally, use the below command to start the documentation server on your localhost.
70
+
4. Run the development server
85
71
72
+
**Docusaurus**
73
+
```sh
74
+
pnpm serve
86
75
```
87
-
pnpm run serve
76
+
77
+
**Nextra**
78
+
```sh
79
+
pnpm dev
88
80
```
89
81
82
+
See the README.md in each respective app for more information
83
+
90
84
## Debugging
91
85
92
86
Fix formatting issues by running:
93
87
94
-
```
88
+
```sh
95
89
pnpm fmt
96
90
```
97
91
@@ -101,12 +95,12 @@ The src/contributors.json file (which powers the list of Authors at the bottom o
101
95
102
96
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:
103
97
104
-
```
98
+
```sh
105
99
gh auth login --scopes read:user,user:email
106
100
```
107
101
108
102
Once that is done, you can generate the map with this command:
0 commit comments