Interface PluginReadmeDocument

README content together with source metadata needed by presentation layers.

interface PluginReadmeDocument {
    content: string;
    format: "markdown" | "rst";
    sourceUrl: string;
}

Properties

content: string

Original README text.

format: "markdown" | "rst"

Markup format inferred from the source filename.

sourceUrl: string

Exact URL from which the README was fetched.