API reference

flagstaff/diff

Every export of flagstaff/diff, with its signature and doc comment: diff, plus 1 type.

import { diff } from 'flagstaff/diff';

Functions

A unified diff: unchanged off a terminal, numbered and coloured on one.

function diff(): Component<DiffState>;

Returns Component<DiffState>

interface DiffState {
    /** A unified diff, as `git diff` or `diff -u` prints it. */
    diff: string;
}

flagstaff/markdown

Every export of flagstaff/markdown, with its signature and doc comment: markdownBlocks, markdown, plus 3 types.

flagstaff/box

Every export of flagstaff/box, with its signature and doc comment: box, boxComponent, plus 3 types.