Templates / Technical Manual

Technical Manual PDF template — render it from Markdown

Documentation that engineers actually trust looks like it was written by engineers. The Technical Manual sets monospace headings over a clean sans body with a teal accent on A4 — code blocks with real syntax presence, tables built for parameters, and a hierarchy deep enough for reference material.

Technical Manual
Section heading
Rendered with Inkrun
Before & after

Plain Markdown in. A technical manual worth sending out.

Your manual is already Markdown — in the docs folder, next to the code it describes. Send it as-is: fenced code blocks keep their formatting, nested headings become a navigable structure, and page breaks respect code fences instead of slicing through them. Re-render on every release so the PDF never lags the docs.

technical-manual.mdMD
# Northwind SDK — Operations Manual

## Installation

```bash
npm install @northwind/sdk
export NORTHWIND_API_KEY=nw_live_...
```

## Configuration

| Option      | Type   | Default | Description               |
| ----------- | ------ | ------- | ------------------------- |
| `region`    | string | `us-1`  | API region                |
| `timeout`   | number | `30000` | Request timeout (ms)      |
| `retries`   | number | `3`     | Automatic retry attempts  |

## Basic usage

```ts
import { Northwind } from "@northwind/sdk";

const client = new Northwind({ region: "eu-1" });
const job = await client.jobs.create({ type: "sync" });
```

## Error handling

All SDK errors extend `NorthwindError` and carry a stable
`code`. Retry on `RATE_LIMITED` and `UNAVAILABLE`; treat
everything else as terminal.

> Never retry `INVALID_REQUEST` — fix the payload instead.
technical-manual.pdfPDF
Technical Manual
Section heading
Rendered with Inkrun
Render it your way

Three ways to render the technical manual.

Dashboard

Paste your Markdown in the editor, pick Technical Manual, and download the PDF — no code involved.

REST API
curl https://inkrun.dev/api/v1/render \
  -H "Authorization: Bearer sk_..." \
  -H "Accept: application/pdf" \
  -d '{"template": "technical-manual", "markdown": "# ..."}' \
  --output technical-manual.pdf
MCP · your agent

Add the Inkrun MCP connector once, then ask your agent:

Compile the docs/ folder into a single manual and render it with the technical-manual template.
FAQ

Technical Manual template — common questions.

Do fenced code blocks keep their formatting?

Yes — code renders in a true monospace block with the template's styling, and the theme avoids breaking a fence across pages where possible.

Can I generate one manual from many Markdown files?

Concatenate them in your build step (or let your agent do it) and send one document — heading levels keep the chapters organized.

Is there syntax highlighting?

Code blocks are styled for readability with the template's monospace stack and boxed background; language-aware color highlighting is on the roadmap.

Related templates

If you render technical manuals, you probably ship these too.

API Reference
API Reference

Roboto Mono headings and grid tables for endpoint docs.

A4Roboto Mono headInter body
Explore this template
Runbook
Runbook

Operational runbook in a calm teal with monospace headings.

A4Mono headRoboto body
Explore this template
Section
Design Spec
Design Spec

Montserrat headings over Open Sans in a fresh teal.

A4Montserrat headOpen Sans body
Explore this template
Inkrun © 2026