NxPkg SDK

The NxPkg JavaScript SDK lets you programmatically create NxPkg projects to be opened in a new window or embedded in your docs, example pages, or blog posts.

Documentation

Check out our SDK documentation on developer.nxpkg.github.io:

• SDK overview
• Options reference
• Controlling embeds

Reporting issues

• Issues with the SDK can be filed at https://github.com/nxpkg/sdk/issues
• Other issues with NxPkg can be filed at https://github.com/nxpkg/core/issues

Development

We use npm and Node 16+.

# Install dependencies
npm install

# Start a development server to explore examples
npm start

# Run unit tests
npm test

# Run end-to-end tests with mock server
npm run test:e2e

# Run end-to-end tests against nxpkg.github.io
NXPKG_SERVER_ORIGIN=https://nxpkg.github.io npm run test:e2e

# Generate the 'bundles' and 'types' folders
npm run build