This project is using Ignite UI for Angular components to demonstrate different scenarios related to the usage of each component. The project is tightly related to Ignite UI DocFX Site Builder. All samples are part of the official component topics from our website.
To setup the project run:
npm install
To build the project run:
npm run build
This will produce an AOT build and live editing samples supporting both Sass and CSS.
To start the dev server run:
npm run start
To start the dev server with specific live editing samples style syntax run:
- for Sass
npm run start:styles sass
- for CSS
npm run start:styles css
Use this command to start the server with capability to regenerate live editing JSON files (e.g. "/src/assets/samples/avatar-sample-3.json"
) when a change related to the samples is made:
npm run start:watch-live-editing
If you want to have a specific live editing samples style syntax use:
- for Sass
npm run start:styles:watch-live-editing sass
- for CSS
npm run start:styles:watch-live-editing css
To generate only the live editing samples files (e.g. "/src/assets/samples/avatar-sample-3.json"
) run:
npm run generate-live-editing
For specifix live editing style syntax run:
- for Sass
npm run generate-live-editing -- --styles sass
- for CSS
npm run generate-live-editing -- --styles css
In order to combine the execution of both DocFX and Ignite UI Angular Samples projects, use npm run start
.
After starting both projects you will see the embed samples into the DocFX site builder, under localhost:port
hostname.