@benrbray/micromark-extension-cite/dist/micromark-extension-cite.d.ts

Micromark syntax extension for pandoc-style citations.

import { Extension } from 'micromark-util-types';
import { Token } from 'micromark-util-types';

/**
 * Converts a token stream produced by the syntax extension
 * directly to HTML, with no intermediate AST.  For example,
 *
 * These functions rely on some unknown global state, so
 * if the input token stream is invalid, this function will
 * likely produce mysterious, difficult-to-diagnose errors.
 */
export declare function citeHtml(this: any, opts?: CiteHtmlOptions): {
    enter: {
        inlineCite: (this: any) => undefined;
    };
    exit: {
        inlineCite: (this: any, token: Token) => undefined;
        citeItemKey: (this: any, token: Token) => undefined;
    };
};

declare type CiteHtmlOptions = {};

/**
 * Adds support for [`pandoc`-style citations](https://pandoc.org/MANUAL.html#citations-in-note-styles)
 * to `micromark`.  Here are some examples of valid citations:
 *
 *    ```txt
 *    [@wadler1990:comprehending-monads]          --> (Wadler 1990)
 *    [-@wadler1990]                              --> (1990)
 *    [@hughes1989, sec 3.4]                      --> (Hughes 1989, sec 3.4)
 *    [see @wadler1990; and @hughes1989, pp. 4]   --> (see Wadler 1990 and Hughes 1989, pp. 4)
 *    ```
 */
export declare function citeSyntax(options?: Partial<CiteSyntaxOptions>): Extension;

export declare interface CiteSyntaxOptions {
    /**
     * Enable the alternative syntax, `@[wadler1989]`.  The
     * first citation item can have a suffix, but no prefix.
     * There are no restrictions on subsequent items.
     * @default `false`
     */
    enableAltSyntax: boolean;
    /**
     * Enable the pandoc-style syntax, like `[@wadler1989]`.
     * Each individual citation can have a prefix and suffix.
     * @default `true`
     */
    enablePandocSyntax: boolean;
}

export { }