Documentation and code examples for Vaadin 14 (LTS).
Files not explicitly listed below are from the standard Vaadin project setup.
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 Authoring articles to learn how to write documentation articles.
Project related scripts (tests, validation builds, preview deployment, etc).
Files related to linting the articles against the writing style guidelines with Vale. See Vale linter setup instructions.