Skip to content

VellumCurated docs that don't drift.

Write templates that reference your source code: types, constants, functions, TSDoc comments. And Vellum compiles them into plain Markdown, MDX, or HTML that any docs host can consume without runtime support.

jinja2
# Types

{% set t = symbol("ts:src/types.ts#User") %}

## {{ t.name }}

{{ t.doc.summary }}

```ts
{{ t | declaration }}
```

| Field | Type | Description |
| ----- | ---- | ----------- |
{% for m in t.members -%}
| `{{ m.name }}`{% if m.optional %} _(optional)_{% endif %} | {{ m.type | cell }} | {{ m.doc.summary | cell }} |
{% endfor %}

Released under the MIT License.