Skip to content

graphieros/vue-data-ui-doc

Repository files navigation

vue-data-ui documentation website

Vue Data UI is a Vue 3 data visualization components library.

This repo contains the code for the documentation website, designed to offer a maximum of information on the library and facilitate its usage.

The repo for the actual Vue Data UI library is available here.

Contributions to the documentation website

Contributions are welcome:)

The documentation website was built in a hurry, so it might appear messy. We are gradually refactoring it so it becomes more pleasing to maintain.

Translations

Translations are setup on a Pinia store (useMainStore), and serve translations for the following languages:

  • Chinese (simplified)
  • English
  • French
  • German
  • Japanese
  • Korean
  • Portuguese
  • Spanish

The quality of translations is probably dubious, as most of them were generated with Google translate.

Features

The main features of the documentation website are the following:

  • Full docs page for each component
  • Quick components overview
  • Search engine for config attributes
  • Example charts
  • Customization tips
  • Chart builder
  • Package stats