honkit/lib/models/readme.d.ts

HonKit is building beautiful books using Markdown.

import Immutable from "immutable";
import File from "./file";
declare const Readme_base: Immutable.Record.Class;
declare class Readme extends Readme_base {
    getFile(): File;
    getTitle(): string;
    getDescription(): string;
    /**
     Create a new readme

     @param {File} file
     @param {Object} def
     @return {Readme}
     */
    static create(file: File, def: {
        title?: any;
        description?: any;
    }): Readme;
}
export default Readme;
//# sourceMappingURL=readme.d.ts.map