Bitbucket Data Center API Client
    Preparing search index...

    Interface MarkupFileParams

    Query parameters accepted by the repository markup-file endpoints (GET /rest/api/latest/projects/{key}/repos/{slug}/readme and the license/contributing equivalents).

    interface MarkupFileParams {
        at?: string;
        hardwrap?: boolean;
        htmlEscape?: boolean;
        includeHeadingId?: boolean;
        markup?: string;
    }
    Index

    Properties

    at? hardwrap? htmlEscape? includeHeadingId? markup?

    Properties

    at?: string

    Branch, tag, or commit to read the file at; defaults to the default branch

    hardwrap?: boolean

    Whether single newlines are rendered as hard line breaks

    htmlEscape?: boolean

    Whether HTML in the markup should be escaped

    includeHeadingId?: boolean

    Whether rendered headings get an id attribute

    markup?: string

    Markup implementation used to render the file

    Settings

    Member Visibility

    On This Page

    Properties