Files
nym/documentation/docs
mx bf05930fa8 Max/individual command autodocs (#5018)
* updated autodoc script

* updated autodoc script for fix + reintroduced gitignore file for generated markdown

* auto commit generated command files

* auto commit generated command files

* added command-outputs to autodoc script

* fix merge conflicts

* repush components
2024-10-24 13:58:38 +02:00
..
2024-10-24 13:58:37 +02:00
2024-10-24 13:58:38 +02:00
2024-10-24 13:54:46 +02:00
2024-10-24 13:54:47 +02:00
2024-10-24 13:58:38 +02:00
2024-10-24 13:54:46 +02:00

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 using the template from here https://github.com/shuding/nextra-docs-template.