37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
|
---
|
||
|
|
sidebar_position: 1
|
||
|
|
---
|
||
|
|
|
||
|
|
# Introduction
|
||
|
|
|
||
|
|
<!-- extract of <rootdir>/README.md -->
|
||
|
|
`maxGraph` is a TypeScript library which can display and allow interaction with vector diagrams. At a high level, it provides:
|
||
|
|
- **Nodes**, also known as **vertices** which are typically represented by shapes like rectangles.
|
||
|
|
- **Edges** which can be lines and arrows which normally point between one node and another.
|
||
|
|
|
||
|
|
It provides many of the diagramming features which would be expected by a piece of presentation software like Microsoft® PowerPoint™
|
||
|
|
or LibreOffice® Impress such as being able to resize, move or rotate nodes, but has a stronger focus on automatic layout
|
||
|
|
algorithms and applications of [Graph Theory](https://en.wikipedia.org/wiki/Graph_theory). It is suited towards software
|
||
|
|
which requires finer-grained customization of functionality than off-the-shelf packages.
|
||
|
|
<!-- END OF 'extract of <rootdir>/README.md' -->
|
||
|
|
|
||
|
|
## About this documentation
|
||
|
|
|
||
|
|
:::warning
|
||
|
|
|
||
|
|
This documentation is a **work in progress**. Please be patient, the content will be updated progressively.
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
Please check the maxGraph repository **README**:
|
||
|
|
- [installation](https://github.com/maxGraph/maxGraph/blob/development/README.md#install)
|
||
|
|
- [getting started](https://github.com/maxGraph/maxGraph/blob/development/README.md#getting-started)
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Let's continue with the [Usage](/docs/category/usage) documentation.
|