remark-images
Version:
remark plugin to add a simpler image syntax
31 lines • 863 B
TypeScript
/**
* Add a simpler image syntax.
*
* @param {Readonly<Options> | null | undefined} [options]
* Configuration (optional).
* @returns
* Transform.
*/
export default function remarkImages(options?: Readonly<Options> | null | undefined): (tree: Root) => undefined;
/**
* Extensions recognized as images by default.
*
* @type {ReadonlyArray<string>}
*/
export const defaultImageExtensions: ReadonlyArray<string>;
/**
* Configuration (optional).
*/
export type Options = {
/**
* File extensions (without dot) to treat as images (default:
* `defaultImageExtensions`).
*/
imageExtensions?: ReadonlyArray<string> | null | undefined;
/**
* Whether to wrap the image with a link to it (default: `true`).
*/
link?: boolean | null | undefined;
};
import type { Root } from 'mdast';
//# sourceMappingURL=index.d.ts.map