You’re browsing the documentation for v5. View the docs for the latest version →
Change your current terminal directory to the project root with
Then run tasks with
npm run task-name, e.g.
npm run dev.
|Starts the development server with file watching and auto reload.|
|Builds production-ready files for CMS integration. Outputs to |
|Generates a version of Pangolin.js for static file servers. Outputs to |
|Lints CSS with stylelint.|
Tasks are pre-defined
package.json scripts for the corresponding
.eslintrc.json. Per-file rules can be set with comments (e.g.
// eslint-disable no-console). Exclude files from linting with an
.eslintignore configuration file.
build task produces up to three files in normal mode:
|Third-party scripts from |
|Main application code.|
build --modern mode generates three additional files:
These skip transpilations to ES5 in order to serve smaller bundles for modern browsers.
stylelint monitors the code for errors and consistency deviations defaulting to the Sass Guidelineswith a few additions. Global stylelint rules are set in
.stylelintrc.json. Per-file rules can be set with comments (e.g.
/* stylelint-disable selector-max-id */). Exclude CSS files from linting with a
.stylelintignore configuration file.
build task produces up to two files:
|Third-party CSS from |
|Main application CSS.|
Nunjucks resolves all file paths relative to the
The Nunjucks templates are for development and reference purposes only and the
build task will not create any HTML. The
dev task serves the components folder with a built-in web server. The
build:dev task generates HTML for static file servers.