Zum Inhalt springen
⌘K

AuthorProfile

Als Markdown ansehen
Auf dieser Seite
Diese API-Referenz wird aus den englischen TypeScript-Quellkommentaren erzeugt. Namen, Signaturen und Beispiele entsprechen dem veröffentlichten Paket.
import type { AuthorProfile } from "ardo/ui"

type AuthorProfile = {
    /** Registry key, supplied in resolved publication data. */
    id?: string;
    name: string;
    avatar?: string;
    description?: string;
    title?: string;
    /**
     * Absolute `http://` or `https://` profile URL. Ardo links the author's name to it, uses it as
     * the Atom author `<uri>`, and adds it to the post's `BlogPosting` structured data. Another
     * value prints a build warning and is left out of the structured data.
     */
    url?: string;
    links?: Array<{
        name: string;
        url: string;
    }>;
    did?: string;
};

Properties

NameTypeRequiredDescription
idstringNoRegistry key, supplied in resolved publication data.
namestringYes
avatarstringNo
descriptionstringNo
titlestringNo
urlstringNoAbsolute http:// or https:// profile URL. Ardo links the author's name to it, uses it as
the Atom author <uri>, and adds it to the post's BlogPosting structured data. Another
value prints a build warning and is left out of the structured data.
linksArray<{ name: string; url: string }>No
didstringNo