@nolebase/vitepress-plugin-git-changelog/dist/client/types.d.ts

A VitePress plugin that adds a changelog fetched from git to your documentation.

export interface Locale extends Record<string, any> {
    /**
     * What to display when there are no logs
     *
     * @deprecated Use `changelog.noData` instead
     */
    noLogs?: string;
    /**
     * What to display when there are no contributors
     *
     * @deprecated Use `contributors.noData` instead
     */
    noContributors?: string;
    /**
     * What to display when the page was last edited
     *
     * @deprecated Use `changelog.lastEdited` instead
     */
    lastEdited?: string;
    /**
     * The name of the locale to use for date-fns
     *
     * @deprecated Use `changelog.lastEditedDateFnsLocaleName` instead
     */
    lastEditedDateFnsLocaleName?: string;
    /**
     * What to display when the user wants to view the full history
     *
     * @deprecated Use `changelog.viewFullHistory` instead
     */
    viewFullHistory?: string;
    /**
     * What to display when the commit was committed
     *
     * @deprecated Use `changelog.committedOn` instead
     */
    committedOn?: string;
    /**
     * The changelog section configuration
     */
    changelog?: {
        /**
         * The title of the changelog section
         */
        title?: string;
        /**
         * What to display when there are no logs
         */
        noData?: string;
        /**
         * What to display when the page was last edited
         */
        lastEdited?: string;
        /**
         * The name of the locale to use for date-fns
         */
        lastEditedDateFnsLocaleName?: string;
        /**
         * What to display when the user wants to view the full history
         */
        viewFullHistory?: string;
        /**
         * What to display when the commit was committed
         */
        committedOn?: string;
    };
    /**
     * The contributors section configuration
     */
    contributors?: {
        /**
         * The title of the contributors section
         */
        title?: string;
        /**
         * What to display when there are no contributors
         */
        noData?: string;
    };
}
export interface Options {
    /**
     * Internationalization configuration
     *
     * When configuring, please configure according to the language code configured in
     * VitePress internationalization configuration. In the following configuration, 'en'
     * and 'zh-CN' are the language codes configured in VitePress internationalization
     * configuration.
     *
     * @default undefined
     * @example
     * ```ts
     * {
     *  locales: {
     *    'en': {
     *      noLogs: 'No recent changes',
     *      lastEdited: 'This page was last edited {{daysAgo}}',
     *      lastEditedDateFnsLocaleName: 'enUS',
     *      viewFullHistory: 'View full history',
     *      committedOn: ' on {{date}}',
     *    },
     *    'zh-CN': {
     *      noLogs: '暂无最近变更历史',
     *      lastEdited: '本页面最后编辑于 {{daysAgo}}',
     *      lastEditedDateFnsLocaleName: 'zhCN',
     *      viewFullHistory: '查看完整历史',
     *      committedOn: '于 {{date}} 提交',
     *     },
     *   }
     * }
     * ```
     */
    locales?: Record<string, Locale>;
    /**
     * Number of commit hash letters to display
     *
     * @default 7
     */
    numCommitHashLetters?: number;
    /**
     * Whether to display the relative time of the commit
     * in the format as 'x days ago' or 'x hours ago'
     */
    commitsRelativeTime?: boolean;
    /**
     * Whether to hide the changelog h2 header
     */
    hideChangelogHeader?: boolean;
    /**
     * Whether to hide the changelog "No changes" text when there are no changes
     */
    hideChangelogNoChangesText?: boolean;
    /**
     * Whether to hide the contributors h2 header
     */
    hideContributorsHeader?: boolean;
    /**
     * Whether to hide the sort by button
     */
    hideSortBy?: boolean;
    /**
     *  Whether to display authors of commits right inside of commit line
     */
    displayAuthorsInsideCommitLine?: boolean;
}