Coursereader API - v0.1.0
    Preparing search index...

    Interface PlaygroundOptions

    Content and section options for createPlayground.

    interface PlaygroundOptions {
        sampleDocument?: string;
        sampleDocumentRight?: string;
        sections?: { playground?: boolean; viewer?: boolean };
        subtitle?: string;
        title?: string;
        viewerPages?: string[];
    }
    Index
    sampleDocument? sampleDocumentRight? sections? subtitle? title? viewerPages?
    sampleDocument?: string

    HTML for the left (verso) sample sheet. Keep the id "sample-document" so the playground can find it.

    sampleDocumentRight?: string

    HTML for the right (recto) sample sheet. Keep the id "sample-document-2".

    sections?: { playground?: boolean; viewer?: boolean }

    Which sections to render. Both default to true.

    Type Declaration

    • Optionalplayground?: boolean

      Render the interactive playground section.

    • Optionalviewer?: boolean

      Render the multi-page viewer section.

    subtitle?: string

    Header subtitle.

    title?: string

    Header title.

    viewerPages?: string[]

    HTML for the viewer pages. Keep the ids "viewer-page-1" through "viewer-page-4".

    Settings
    Member Visibility

    On This Page
    Properties