# graphviz-doc-builder

> An api to build documents for graphviz

Latest version **0.1.0** (published 2018-05-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install graphviz-doc-builder
pnpm add graphviz-doc-builder
yarn add graphviz-doc-builder
bun add graphviz-doc-builder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-05-26 |
| First published | 2018-05-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | grgrdvrt |
| Maintainers | grgrdvrt |
| Keywords | graphviz, dot, graph |

## Links

- npm: https://www.npmjs.com/package/graphviz-doc-builder
- Repository: https://github.com/grgrdvrt/dot
- Homepage: https://github.com/grgrdvrt/dot#readme
- Issues: https://github.com/grgrdvrt/dot/issues
- npm.io page: https://npm.io/package/graphviz-doc-builder

## Recent versions

- 0.1.0 (latest) — 2018-05-26

## README

# dot
api to build dot documents for graphviz

# Example

```javascript
const dot = require("graphviz-doc-builder");

const helloNode = dot.node("hello");
const worldNode = dot.node("world");
const edge = dot.edge(helloNode, worldNode);
const graph = dot.graph()
      .setParams({isOriented:true})
      .add(helloNode, worldNode, edge);

console.log(graph.toString());
```

will output
```
 digraph "2" {
	0 [label = "hello"];
	1 [label = "world"];
	"0" -> "1" [];
}

```
The goal of this api is to ease the construction of large dot files.


# requirements

---
_Source: https://npm.io/package/graphviz-doc-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._