Site Guide
This document is mainly to help you use the VGrammar site better and help you get the content you want on the site more quickly.
Quick Start
Get started quickly
First, you need to complete the VGrammar Quick Start chapter that will teach you how to set up and use the environment needed for VGrammar, as well as how to build your first graphic.
Understand grammar elements
After completing the Quick Start, you can understand some basic concepts of VGrammar by studying the Grammar Elements chapter.
Documentation
VGrammar's documentation provides detailed information on features and configurations. Depending on your needs, you can check out the following sections:
- Tutorial: Introduces the basic concepts and various usage methods of VGrammar charts.
- Spec: Provides detailed descriptions of all configuration items and their detailed explanations for VGrammar charts.
- API: Provides detailed descriptions of all available interfaces for VGrammar.
Chart Examples
The Chart Examples page provides many practical application examples of VGrammar charts, from simple bar and line charts to complex pie and radar charts. Each example provides a detailed description, key configuration information, and source code. You can also modify the examples through the online editor and view the results.
How to use the search feature
The site provides a powerful search feature that allows you to quickly find relevant usage information. Click on the search box at the top of the site, enter a keyword, and you'll see matching results in the dropdown list. Select a suitable result to view related content.
How to ask questions & provide suggestions
We're happy to help you! If you encounter problems while learning VGrammar, you can ask questions in the following ways:
- Submit an issue in the GitHub repository: Visit VGrammar GitHub, describe the problem you encountered in detail, and our team will respond and solve it as soon as possible.
- Submit a discussion in the GitHub repository: Visit VGrammar Discussion, and we welcome your thoughts and suggestions here. Our team will respond and address them as soon as possible.
How to report errors
If you find issues with the documentation examples or think some parts could be improved, please let us know. You can provide error correction information to us through the following methods:
- Submit a pull request in the GitHub repository: Correct the content and submit, and a team member will review and merge it.
- Submit an issue: Point out problems in the documentation so that team members can verify and correct them as soon as possible.
Thank you for your help! We will continue to improve the documentation to provide a better learning experience for all VGrammar users.