@statelyai/graph 0.10.0 → 0.11.1

package/README.md

@@ -1,3 +1,7 @@
+---
+title: '@statelyai/graph'
+---
+
 # @statelyai/graph
 
 A TypeScript graph library built on plain JSON objects. Supports directed/undirected graphs, hierarchical nodes, graph algorithms, visual properties, and serialization to DOT, GraphML, Mermaid, and more.
@@ -12,6 +16,8 @@ npm install @statelyai/graph
 
 Optional peers are only needed for specific adapters:
 
+<!-- optional peer dependencies derived from package.json#peerDependencies -->
+
 | Package | Needed for |
 | --- | --- |
 | `fast-xml-parser` | `@statelyai/graph/gexf`, `@statelyai/graph/graphml` |
@@ -135,7 +141,9 @@ getEdgesByPort(graph, 'render', 'input'); // [e1]
 
 ## Algorithms
 
-Includes traversal (BFS, DFS), pathfinding (shortest path, simple paths, all-pairs shortest paths), centrality/link analysis (degree, closeness, betweenness, PageRank, HITS, eigenvector), community detection (label propagation, Girvan-Newman, greedy modularity, modularity scoring), cycle detection, connected/strongly-connected components, bridges, articulation points, biconnected components, isomorphism, topological sort, minimum spanning tree, and more. Many algorithms have lazy generator variants (`gen*`) for early exit.
+<!-- algorithm functions exported from src/algorithms.ts -->
+
+Includes traversal (BFS, DFS, preorder/postorder), pathfinding (shortest path, simple paths, all-pairs shortest paths, A*), centrality/link analysis (degree, closeness, betweenness, PageRank, HITS, eigenvector), community detection (label propagation, Girvan-Newman, greedy modularity, modularity scoring), cycle detection, connected/strongly-connected components, bridges, articulation points, biconnected components, isomorphism, topological sort, minimum spanning tree, and more. Many algorithms have lazy generator variants (`gen*`) for early exit.
 
 ```ts
 import {
@@ -203,7 +211,9 @@ const d3Data = toD3Graph(graph);             // D3.js { nodes, links }
 const imported = fromGEXF(gexfXmlString);    // GEXF (Gephi)
 ```
 
-**Supported formats:** Cytoscape.js JSON, D3.js JSON, JSON Graph Format, GEXF, GraphML, GML, TGF, DOT, Mermaid (flowchart, state, sequence, class, ER, mindmap, block), adjacency list, and edge list.
+<!-- supported format adapters derived from src/formats/* subdirectories -->
+
+**Supported formats:** Cytoscape.js JSON, D3.js JSON, JSON Graph Format, GEXF, GraphML, GML, TGF, DOT, Mermaid (flowchart, state, sequence, class, ER, mindmap, block, Ishikawa), ELK, xyflow, adjacency list, and edge list.
 
 Each bidirectional format also has a converter object:
 
@@ -218,19 +228,27 @@ Some formats have optional peer dependencies: `fast-xml-parser` (GEXF, GraphML)
 
 Format-specific docs live alongside the source:
 
+<!-- format README files under src/formats/*/README.md -->
+
+- [Adjacency list](./src/formats/adjacency-list/README.md)
+- [Cytoscape](./src/formats/cytoscape/README.md)
+- [D3](./src/formats/d3/README.md)
 - [DOT](./src/formats/dot/README.md)
-- [GraphML](./src/formats/graphml/README.md)
+- [Edge list](./src/formats/edge-list/README.md)
+- [ELK](./src/formats/elk/README.md)
 - [GEXF](./src/formats/gexf/README.md)
 - [GML](./src/formats/gml/README.md)
+- [GraphML](./src/formats/graphml/README.md)
 - [JGF](./src/formats/jgf/README.md)
-- [TGF](./src/formats/tgf/README.md)
-- [Cytoscape](./src/formats/cytoscape/README.md)
-- [D3](./src/formats/d3/README.md)
 - [Mermaid](./src/formats/mermaid/README.md)
+- [TGF](./src/formats/tgf/README.md)
+- [xyflow](./src/formats/xyflow/README.md)
 - [Converter helpers](./src/formats/converter/README.md)
 
 ## Examples
 
+<!-- runnable example files under examples/ -->
+
 The repo includes runnable examples under [`examples/`](./examples):
 
 - [Flow-based math](./examples/flow-based-math.ts) shows ports, topological ordering, and value propagation.
@@ -238,6 +256,8 @@ The repo includes runnable examples under [`examples/`](./examples):
 
 ## Development
 
+<!-- dev commands from package.json#scripts -->
+
 ```bash
 pnpm install
 pnpm verify