Documentation versions (currently viewingVaadin 24)

Getting Started with Design System Publisher

Set up your own design system documentation project using Design System Publisher.

Setting Up Your Environment

Before using the Design System Publisher tool, you need to have the following development tools set up:

  • Vaadin development tools

    The documentation contains a Vaadin project for rendering UI examples, and you need to have the same development tools installed when doing Vaadin application development.

  • Git

    The CLI tool uses Git to clone an initial copy of the documentation project, so make sure to have Git installed.

  • Node.js

    Design System Publisher uses Node.js, so make sure to have it installed. Version 16 is recommended.

Create a New Project

Run the following command to create a new design system website project:

npx @vaadin/cli@2.7.0 dsp-init
New to terminal?
The terminal – also referred to as the command line or shell – is a text-based interface used to run commands on your computer. If you’re new to the terminal, see instructions for Windows, macOS, and Linux.

The tool asks for the name of your design system, which is used for things like the visible page title, and a folder name for the website project.

The initialization script should take about a minute to finish. Once done, you should have the website project in your current working directory. The project uses Git for version control.

Next Steps

See Development Server to learn how to run Design System Publisher locally.

See Production Setup to learn how to run prepare the documentation website for production deployment/hosting.

See the other articles to learn how to customize the content and the styles of your documentation website.