blackpjotr / docs

Official Vaadin documentation, for all parts of the platform.

Vaadin documentation

Official documentation and code examples for Vaadin.

This repository does not generate the vaadin.com/docs website. It only contains the content for it. The build is done using Vaadin Design System Publisher.

Contents

Files not explicitly listed below are from the standard Vaadin project setup.

articles

A hierarchy of AsciiDoc (either .asciidoc or .adoc) files, documenting the use of all Vaadin features. The file path defines the resulting URL on the documentation site.

For example:

• articles/intro/index.asciidoc → /intro/
• articles/forms/data-binding.asciidoc → /forms/data-binding/

See the contribution guides to learn how to write documentation articles.

frontend

TypeScript examples, which are included as rendered examples in the documentation. Follow Vaadin best practices when creating code examples.

src

Flow/Java examples, which are included as rendered examples in the documentation. Follow Vaadin best practices when creating code examples.

scripts

Project related scripts (tests, validation builds, preview deployment, etc).

.github

Files related to linting the articles against the writing style guidelines with Vale. See Vale linter setup instructions.

versions.json

Describes the publicly available documentation versions. These versions will appear in the published website, as options for the users. This file is only relevant in the latest branch.