nimiq-vitepress-theme/dist/vite/index.d.ts

Nimiq UI theme for VitePress

import type { Plugin } from 'vite';
import { GitChangelog } from '@nolebase/vitepress-plugin-git-changelog/vite';
import llmstxt from 'vitepress-plugin-llms';
type GitChangelogOptions = Parameters<typeof GitChangelog>[0];
type LlmsPluginOptions = Parameters<typeof llmstxt>[0];
export interface NimiqVitepressVitePluginOptions {
    /**
     * GitHub repository URL (e.g., 'https://github.com/owner/repo')
     * Used as default for GitChangelog and for constructing source code URLs
     */
    repoURL?: string;
    /**
     * Content directory path relative to repository root
     * Specifies where documentation files are located
     * @default '' (repository root)
     */
    contentPath?: string;
    /**
     * Git changelog configuration
     * If not provided, will use repoURL as default
     * Set to false to disable changelog
     */
    gitChangelog?: GitChangelogOptions | false;
    /**
     * LLMs.txt plugin configuration
     * Automatically generates llms.txt and llms-full.txt during build
     * Set to false to disable (only mdream markdown generation will be used)
     * @default true
     */
    llms?: LlmsPluginOptions | boolean;
}
export declare function NimiqVitepressVitePlugin({ repoURL, contentPath, gitChangelog, llms, }: NimiqVitepressVitePluginOptions): Plugin[];
export {};