hirsun-vuepress-theme-hope-plus/lib/shared/blog.d.ts

A light vuepress theme with tons of features and typewriter effect

import type { ReadingTime } from "vuepress-plugin-reading-time2";
import type { Author } from "vuepress-shared";
export declare const enum ArticleInfoType {
    type = "y",
    title = "t",
    shortTitle = "s",
    icon = "i",
    author = "a",
    date = "d",
    localizedDate = "l",
    category = "c",
    tag = "g",
    isEncrypted = "n",
    isOriginal = "o",
    readingTime = "r",
    excerpt = "e",
    sticky = "u",
    cover = "v",
    index = "I",
    order = "O"
}
export declare const enum PageType {
    article = "a",
    home = "h",
    slide = "s",
    page = "p"
}
export interface ArticleInfo extends Record<string, unknown> {
    /**
     * Type
     */
    [ArticleInfoType.type]: PageType;
    /**
     * Article title
     */
    [ArticleInfoType.title]: string;
    /**
     * Article short title
     */
    [ArticleInfoType.shortTitle]: string;
    /**
     * Page icon
     */
    [ArticleInfoType.icon]?: string;
    /**
     * Whether this page should be indexed
     *
     * used in other functions, e.g.: sidebar and catalog
     */
    [ArticleInfoType.index]?: boolean;
    /**
     * The order of this page in same directory
     */
    [ArticleInfoType.order]?: number;
    /**
     * Article author
     */
    [ArticleInfoType.author]?: Author | false;
    /**
     * writing date info
     */
    [ArticleInfoType.date]?: number;
    /**
     * writing date info in current language
     */
    [ArticleInfoType.localizedDate]?: string;
    /**
     * article category
     */
    [ArticleInfoType.category]?: string[];
    /**
     * Article tag
     */
    [ArticleInfoType.tag]?: string[];
    /**
     * Reading time info
     */
    [ArticleInfoType.readingTime]?: ReadingTime;
    /**
     * article excerpt
     */
    [ArticleInfoType.excerpt]: string;
    /**
     * Whether is encrypted
     */
    [ArticleInfoType.isEncrypted]?: true;
    /**
     * Whether is original
     */
    [ArticleInfoType.isOriginal]?: true;
    /**
     * Sticky info
     */
    [ArticleInfoType.sticky]?: number | boolean;
    /**
     * Cover image
     */
    [ArticleInfoType.cover]?: string;
}