Interface GitalkOptions

typings/index.d.ts:32–166

declare namespace Gitalk {
    interface GitalkOptions {
        /**
         * GitHub Application Client ID.
         */
        clientID: string;

        /**
         * GitHub Application Client Secret.
         */
        clientSecret: string;

        /**
         * Name of Github repository.
         */
        repo: string;

        /**
         * GitHub repository owner.
         * Can be personal user or organization.
         */
        owner: string;

        /**
         * GitHub repository owner and collaborators.
         * (Users who having write access to this repository)
         */
        admin: string[];

        /**
         * The unique id of the page.
         * Length must less than 50.
         *
         * @default location.href
         */
        id?: string;

        /**
         * The issue ID of the page.
         * If the number attribute is not defined, issue will be located using id.
         *
         * @default -1
         */
        number?: number;

        /**
         * GitHub issue labels.
         *
         * @default ['Gitalk']
         */
        labels?: string[];

        /**
         * GitHub issue title.
         *
         * @default document.title
         */
        title?: string;