The main branches in the repository are
latest for the latest version of Vaadin, and
hilla for the Hilla documentation.
You can make small corrections or suggestions to the documentation by clicking the Edit this page on GitHub link at the end of any page. It opens that page for editing in GitHub — you’ll need a GitHub account. There you can edit the content and later submit a pull request. For external contributors, a fork of the repository is created on your own GitHub account.
The GitHub editor is good for small edits, but not for writing new pages or large sections. The preview rendering on GitHub doesn’t show the content the same as the official documentation website. This is because Design System Publisher has custom extensions and styling. To see an exact preview of a page you’re editing, you’ll need to run the development server, locally.
To edit and preview locally the documentation website on your computer, do the following steps:
First, clone the repository. For example, you would execute the following from the command-line:
git clone https://github.com/vaadin/docs
Next, start Design System Publisher by entering the following in the
cd docs npm run dspublisher:start
You need a commercial Vaadin subscription to run Design System Publisher. Once the development server is up and running, the website should open up in your browser on http://localhost:8000.
When editing an AsciiDoc file in Visual Studio Code, you might get the following error annotation on the main heading or title of all pages:
level 0 sections can only be used when doctype is book
Add the following snippet to your VS Code
settings.json file to avoid this: