docs: add structure section and improve npm package details by tbouffard · Pull Request #792 · maxGraph/maxGraph · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
8 changes: 8 additions & 0 deletions packages/website/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ Install the latest version of `maxGraph` from the [npm registry](https://www.npm
</TabItem>
</Tabs>

:::info
`maxGraph` is written in TypeScript and provides type definitions for seamless integration into TypeScript applications.

Compatibility of the npm package:
- The JavaScript code conforms to `ES2020` and is provided as ES Modules only
- TypeScript integration requires **TypeScript 3.8** or higher
:::

[//]: # (END OF 'extract of <rootdir>/README.md')


Expand Down
16 changes: 8 additions & 8 deletions packages/website/docs/intro.md