Improves docs.
This commit is contained in:
@@ -1,11 +1,17 @@
|
||||
# Visualization Bundle
|
||||
|
||||
This package registers various visualizations. If you have an idea for a cool visualization, add it here!
|
||||
|
||||
## Installation
|
||||
|
||||
You can use yarn to install this library:
|
||||
|
||||
```
|
||||
yarn add @hediet/visualization-bundle
|
||||
```
|
||||
|
||||
Install `@hediet/visualization-core` before!
|
||||
|
||||
## Usage
|
||||
|
||||
Import `@hediet/visualization-bundle` to register all default visualizations to `globalVisualizationFactory` of `@hediet/visualization-core`:
|
||||
@@ -50,7 +56,9 @@ See docs of `@hediet/visualization-core` for how to find and render visualizatio
|
||||
|
||||
## Supported Visualizations
|
||||
|
||||
### Origin Visualizations
|
||||
You can find a playground that demonstrates all visualizations [here](https://hediet.github.io/visualization/).
|
||||
|
||||
### Source Visualizations
|
||||
|
||||
- Tree Visualizer
|
||||
- AST Visualizer (+ Monaco Source Code View)
|
||||
@@ -59,7 +67,7 @@ See docs of `@hediet/visualization-core` for how to find and render visualizatio
|
||||
- Image Visualizer
|
||||
- Simple Text Visualizer
|
||||
|
||||
### Integrated Visualizations
|
||||
### Integrated Visualization Libraries
|
||||
|
||||
- Plotly Visualizer
|
||||
- Perspective JS Visualizer
|
||||
@@ -69,6 +77,12 @@ See docs of `@hediet/visualization-core` for how to find and render visualizatio
|
||||
- Vis.js Visualizer
|
||||
- Monaco Editor Source Code Visualizer
|
||||
|
||||
```
|
||||
## Setup Local Development Copy
|
||||
|
||||
```
|
||||
- Clone this repository.
|
||||
- Run `yarn` in the root folder.
|
||||
- Run `yarn dev` in the `visualization-bundle` folder to start tsc in watch mode.
|
||||
- Edit [./playground/src/visualization.ts](../playground/src/visualizations.ts) to your needs to improve webpack performance.
|
||||
- Run `yarn dev` in the `playground` folder to start the playground where you can debug your visualization.
|
||||
|
||||
Please use the [`simple-text-visualizer`](./src/visualizers/simple-text-visualizer/index.tsx) as starting point!
|
||||
|
||||
Reference in New Issue
Block a user