Design System Publisher
Design System Publisher (DSP) is a tool used to compile the Vaadin website’s documentation pages at vaadin.com/docs.
|
Note
|
No Longer Maintained for 3rd-Party Use
Design System Publisher is no longer maintained as a product for third-party use.
Existing installations should continue to work, but the latest Vaadin documentation is unlikely to work correctly with them.
|
For content, DSP uses AsciiDoc, a lightweight markup language similar to Markdown. The system supports embedding live component samples, written in Java or TypeScript, directly into the pages. The system can automatically provide code snippets for the samples for copy-pasting into code.
Topics
- Getting Started
- Set up your own design system documentation project using Design System Publisher.
- Development Server
- When you edit the pages of your documentation website, you run the Design System Publisher development server locally to to see the resulting website as you edit the content.
- Site Content
- The page hierarchy of the documentation website is defined by the folder structure of files written using the AsciiDoc markup language. Learn how to write these documentation pages.
- Configuration
- Various aspects of the documentation website can be configured through environment variables or with a JSON configuration file.
- Production Setup
- Once you're happy with the content and appearance of your design system documentation site, it's time to build for production deployment.
- Troubleshooting
- This page describes issues you might encounter while using Design System Publisher.
14F4D321-696D-4C41-BC8F-E7EE373F949F