mfahampshire
41 lines
1.0 KiB
Markdown
41 lines
1.0 KiB
Markdown
# Nym Docs v2
|
|
|
|
New consolidated version of the nym docs.
|
|
|
|
## Local development
|
|
|
|
```
|
|
npm i
|
|
npm run dev
|
|
```
|
|
|
|
Open `http://localhost:3000` to browse the output that will hot-reload when you make changes.
|
|
|
|
If you are cutting a new version with binaries that have updated commands (and you have updated the command list in `autodocs`) run:
|
|
|
|
```
|
|
npm generate:commands
|
|
```
|
|
|
|
This will regenerate the md command files for the binaries, move them into position, and then commit them to the branch head.
|
|
|
|
## Build
|
|
|
|
```
|
|
npm run build
|
|
```
|
|
|
|
The static output will be in `./out`;
|
|
|
|
If you are cutting a new version with binaries that have updated commands (and you have updated the command list in `autodocs`) **run this first**:
|
|
|
|
```
|
|
npm generate:commands
|
|
```
|
|
|
|
This will regenerate the md command files for the binaries, move them into position, and then commit them to the branch head.
|
|
|
|
## Template details
|
|
|
|
This documentation was made with [Nextra](https://nextra.site) using the template from here https://github.com/shuding/nextra-docs-template.
|