-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] Fixes minor errors and typos in various doc files
- Loading branch information
Showing
4 changed files
with
10 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ | |
|
||
## Overview | ||
|
||
Here are some quick insights on the codebase. To know more on these topics, please read the [documentation](https://sigmajs.org/docs). | ||
Here are some quick insights on the codebase. To know more on these topics, please read the **[documentation](https://sigmajs.org/docs)**. | ||
|
||
### Architecture | ||
|
||
|
@@ -28,32 +28,18 @@ You can install `sigma` (and `graphology` which is required for `sigma` to work) | |
npm install graphology sigma | ||
``` | ||
|
||
## Examples | ||
## Storybook | ||
|
||
The [`examples`](https://github.com/jacomyal/sigma.js/tree/main/packages/examples) folder contains a series of self-contained TypeScript projects that you can either browse and edit on [CodeSandbox](https://codesandbox.io/) or install locally likewise: | ||
The [`Storybook`](https://github.com/jacomyal/sigma.js/tree/main/packages/storybook) package contains a series of examples that you can either browse likewise: | ||
|
||
```bash | ||
git clone [email protected]:jacomyal/sigma.js.git | ||
cd sigma.js | ||
npm install | ||
cd packages/examples | ||
npm start --example=load-gexf-file # Change this to the desired example | ||
npm run storybook:run | ||
``` | ||
|
||
_List of available examples_ | ||
|
||
- [Fetching and displaying a graph contained in a gexf file](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/load-gexf-file) ([fallback link](https://sigmajs.org/examples/load-gexf-file)) | ||
- [Using node & edge reducers to handle interactivity](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/use-reducers) ([fallback link](https://sigmajs.org/examples/use-reducers)) | ||
- [Fetching, parsing & wrangling a CSV file to create a network map](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/csv-to-network-map) ([fallback link](https://sigmajs.org/examples/csv-to-network-map)) | ||
- [Handling drag and drop of nodes as well as node & edge creation on click](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/mouse-manipulations) ([fallback link](https://sigmajs.org/examples/mouse-manipulations)) | ||
- [Displaying arbitrary elements, such as cluster labels, synchronized with the network](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/clusters-labels) ([fallback link](https://sigmajs.org/examples/clusters-labels)) | ||
- [Applying different animated layout algorithms to a network](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/layouts) ([fallback link](https://sigmajs.org/examples/layouts)) | ||
- [Displaying nodes in various custom ways](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/custom-rendering) ([fallback link](https://sigmajs.org/examples/custom-rendering)) | ||
- [Saving the graph as a PNG image](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/png-snapshot) ([fallback link](https://sigmajs.org/examples/png-snapshot)) | ||
- [Use events to implement interactions](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/events) ([fallback link](https://sigmajs.org/examples/events)) | ||
- [See how sigma behaves with larger graphs](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/large-graphs) ([fallback link](https://sigmajs.org/examples/large-graphs)) | ||
|
||
Also, a more realistic sigma.js based web application is available in the [`demo`](https://github.com/jacomyal/sigma.js/tree/main/packages/demo) folder. It aims to show a real-world usecase, and is the main showcase of [sigma.js website](https://www.sigmajs.org/). | ||
Also, a more realistic sigma.js based web application is available in the [`demo`](https://github.com/jacomyal/sigma.js/tree/main/packages/demo) folder. It aims to show a real-world use case, and is the main showcase of [sigma.js website](https://www.sigmajs.org/). | ||
|
||
## Website | ||
|
||
|