@types/gatsby-transformer-remark

Installation

npm install --save @types/gatsby-transformer-remark

Summary

This package contains type definitions for gatsby-transformer-remark (https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-transformer-remark#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gatsby-transformer-remark.

index.d.ts

export interface RemarkConfig {
    resolve: "gatsby-transformer-remark";
    options?: RemarkOptions | undefined;
}

/**
 * @see https://www.gatsbyjs.com/plugins/gatsby-transformer-remark/#how-to-use
 * @see https://github.com/remarkjs/remark/tree/remark-parse%406.0.3/packages/remark-parse
 */
export interface RemarkOptions {
    /** CommonMark mode (default: true) */
    commonmark?: boolean | undefined;
    /** Footnotes mode (default: true) */
    footnotes?: boolean | undefined;
    /** Pedantic mode (default: true) */
    pedantic?: boolean | undefined;
    /** GitHub Flavored Markdown mode (default: true) */
    gfm?: boolean | undefined;
    /** Plugins configs */
    plugins?: any[] | undefined;
    /**
     * Pass default options to the plugin generating tableOfContents
     * @see https://www.gatsbyjs.com/plugins/gatsby-transformer-remark/#configuring-the-tableofcontents
     */
    tableOfContents?: {
        absolute?: boolean | undefined;
        pathToSlugField?: string | undefined;
        heading?: null | string | undefined;
        maxDepth?: number | undefined;
    } | undefined;
    /**
     * @see https://www.gatsbyjs.com/plugins/gatsby-transformer-remark/#example-excerpts
     */
    excerpt_separator?: string | undefined;
}

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: none

Credits

These definitions were written by Emily M Klassen.