UNPKG

asciidoctor-kroki

Version:

Asciidoctor extension to convert diagrams to images using Kroki

34 lines 1.56 kB
export type KrokiContext = { /** * - Custom virtual filesystem used to read * diagram sources and write generated images. Missing methods fall back to the Node.js * implementation (or to a `fetch`-based implementation in the browser). */ vfs?: Partial<import('./node-fs.js').Vfs>; /** * - Asciidoctor logger; set by the extension while processing. */ logger?: any; }; /** * Extension context shared across diagram processing. * * @typedef {Object} KrokiContext * @property {Partial<import('./node-fs.js').Vfs>} [vfs] - Custom virtual filesystem used to read * diagram sources and write generated images. Missing methods fall back to the Node.js * implementation (or to a `fetch`-based implementation in the browser). * @property {Object} [logger] - Asciidoctor logger; set by the extension while processing. */ declare const _default: { /** * Registers the Kroki extension — a block and a block macro for every supported * diagram type — into the given Asciidoctor extensions registry. * * @param {import('@asciidoctor/core').Registry} registry - Asciidoctor extensions registry. * @param {KrokiContext} [context={}] - Extension context (e.g. a custom virtual filesystem). * @returns {import('@asciidoctor/core').Registry} The registry, for chaining. */ register: (registry: import('@asciidoctor/core').Registry, context?: KrokiContext) => import('@asciidoctor/core').Registry; }; export default _default; //# sourceMappingURL=asciidoctor-kroki.d.ts.map