# ondine/compiler

Render Mermaid to SVG in Node, build tools, and servers.

`ondine/compiler` loads the speed-optimized compiler module for every diagram type from the files of the package. This entrypoint uses the Node filesystem. Browsers and Workers use [`ondine/compiler/wasm`](/docs/api/compiler-wasm) instead.

```ts title="build.ts"
import { render } from 'ondine/compiler'

// Compiles synchronously
const { svg } = render('flowchart LR\n  A --> B')
```

## Functions

<Cards>
  <Card
    title="render"
    icon="code"
    to="/docs/api/compiler/render"
    description="Render source with the bundled module for every type."
  />
  <Card
    title="create"
    icon="boxes"
    to="/docs/api/compiler/create"
    description="Make a renderer from modules that the caller supplies."
  />
</Cards>

## Errors

<Cards>
  <Card
    title="RenderError"
    icon="triangle-alert"
    to="/docs/api/compiler/RenderError"
    description="Thrown for source that cannot be rendered, with the error position."
  />
</Cards>

## Namespaces

| Export   | Contents                                                                                                                                      |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `Render` | The types behind `render` and `create`: `render.Options`, `render.ReturnType`, `create.Options`, `create.ReturnType`, and `RenderError.Code`. |

```ts
import type { Render } from 'ondine/compiler'

// Uses the options type of render for a helper
const options: Render.render.Options = { maxWidth: 640 }
```