DocsGen Guide - Releasing | Diez — The Design Token Framework

DocsGen Guide - Releasing

DocsGen is a purely static web app generated from your Diez project, in order to deploy this app in a server of your choice you need to:

First, compile your Diez project using the docs target:

yarn
npm

$ yarn diez compile -t docs

$ npx diez compile -t docs

Once compiled, you can build your generated app for deployment by running from the root of your design language folder:

yarn
npm

$ cd build/diez-your-project-name-docs
$ yarn build

$ cd build/diez-your-project-name-docs
$ npm run build

This will generate a dist folder that you can deploy to any static file server.

Gotcha Warning: The dist directory is meant to be served by an HTTP server, so it will not work if you open dist/index.html directly over the file:// protocol.

The easiest way to preview your production build locally is using a static file server, for example with:

node

$ npx http-server dist

Is there anything missing or worth improving? Contribute to this documentation on GitHub