function renderDoc
renderDoc(
lines: readonly string[],
palette: Theme
): string

A comment as the prompt should print it: prose muted, and the examples in it read as code.

A fenced example is the part anybody scrolls to — it is the one bit of a doc comment that says what to type — so it is painted the way the same code is painted at the prompt rather than greyed out with the sentences around it.

import { renderDoc } from './docs.ts';

const plain = { painter: () => (text: string) => text };
renderDoc(['what it does'], plain); // 'what it does'
renderDoc([], plain); // '' — nothing written is nothing to print

Parameters

lines: readonly string[]
palette: Theme

Return Type

string

Usage

import { renderDoc } from "lib/repl/docs.ts";