valaxy 0.7.8 → 0.9.0

package/dist/index-328992a1.d.ts

@@ -1,472 +0,0 @@
-import { ViteSSGOptions } from 'vite-ssg';
-import Vue from '@vitejs/plugin-vue';
-import Components from 'unplugin-vue-components/vite';
-import { VitePluginConfig } from 'unocss/vite';
-import MarkdownIt from 'markdown-it';
-import { Theme } from 'shiki';
-import Anchor from 'markdown-it-anchor';
-import { KatexOptions } from 'katex';
-
-interface ValaxyEntryOptions {
-    /**
-     * theme name
-     */
-    theme?: string;
-    userRoot?: string;
-}
-interface ValaxyPluginOptions {
-    vue?: Parameters<typeof Vue>[0];
-    components?: Parameters<typeof Components>[0];
-    unocss?: VitePluginConfig;
-}
-interface ResolvedValaxyOptions {
-    mode: 'dev' | 'build';
-    /**
-     * Client root path
-     * @default 'valaxy/client'
-     */
-    clientRoot: string;
-    /**
-     * User root path
-     * @default process.cwd()
-     */
-    userRoot: string;
-    /**
-     * Theme root path
-     */
-    themeRoot: string;
-    /**
-     * Theme name
-     */
-    roots: string[];
-    theme: string;
-    /**
-     * Valaxy Config
-     */
-    config: ValaxyConfig;
-    /**
-     * config file path
-     */
-    configFile: string;
-    pages: string[];
-}
-interface ValaxyServerOptions {
-    onConfigReload?: (newConfig: ValaxyConfig, config: ValaxyConfig) => void;
-}
-declare function isPath(name: string): boolean;
-/**
- * get theme roots
- * @param name
- * @param entry
- * @returns
- */
-declare function getThemeRoot(name: string, entry: string): string;
-declare function resolveOptions(options: ValaxyEntryOptions, mode?: ResolvedValaxyOptions['mode']): Promise<ResolvedValaxyOptions>;
-/**
- * resolve plugin options
- * @param command
- * @returns
- */
-declare function resolvePluginOptions(command?: 'build' | 'serve'): Promise<ValaxyPluginOptions>;
-
-interface BlockItem {
-    text?: string;
-    icon?: string;
-    color?: string;
-}
-interface Blocks {
-    tip?: BlockItem;
-    warning?: BlockItem;
-    danger?: BlockItem;
-    info?: BlockItem;
-    details?: BlockItem;
-}
-
-declare type ThemeOptions = Theme | {
-    light: Theme;
-    dark: Theme;
-};
-interface MarkdownOptions extends MarkdownIt.Options {
-    config?: (md: MarkdownIt) => void;
-    anchor?: {
-        permalink?: Anchor.AnchorOptions['permalink'];
-    };
-    toc?: {
-        includeLevel?: number[];
-        [key: string]: any;
-    };
-    katex?: KatexOptions;
-    /**
-     * shiki
-     */
-    theme?: ThemeOptions;
-    /**
-     * Custom block configurations
-     */
-    blocks?: Blocks;
-}
-
-declare type ValaxyThemeConfig = Record<string, any>;
-interface SocialLink {
-    /**
-     * The title of your link
-     */
-    name: string;
-    link: string;
-    /**
-     * 图标名称
-     * https://icones.js.org/
-     */
-    icon: string;
-    color: string;
-}
-interface AlgoliaSearchOptions {
-    enable: boolean;
-    appId: string;
-    apiKey: string;
-    indexName: string;
-    placeholder?: string;
-    searchParameters?: any;
-    disableUserPersonalization?: boolean;
-    initialQuery?: string;
-}
-interface ValaxyConfig<T = ValaxyThemeConfig> {
-    /**
-     * Default language
-     * @description 默认语言
-     * @default 'en'
-     */
-    lang: string;
-    /**
-     * You site url in web, required for ssg & rss
-     * @description 站点的 URL，SSG & RSS 需要（譬如生成版权处文章永久链接）
-     * @default '/'
-     */
-    url: string;
-    /**
-     * Site title
-     * @description 站点标题
-     */
-    title: string;
-    /**
-     * 副标题
-     */
-    subtitle: string;
-    /**
-     * 站点描述
-     */
-    description: string;
-    /**
-     * The owner of this blog
-     * @description 博客作者
-     */
-    author: {
-        /**
-         * Your name
-         * @description 你的名字
-         */
-        name: string;
-        email: string;
-        link: string;
-        avatar: string;
-        /**
-         * The status of you
-         * @description 状态
-         */
-        status: {
-            emoji: string;
-            /**
-             * show when hover emoji
-             * @description 当鼠标悬浮在图标上时显示
-             */
-            message: string;
-        };
-    };
-    /**
-     * show last updated time by git
-     */
-    lastUpdated: boolean;
-    /**
-     * icon for your website
-     */
-    favicon: string;
-    feed: {
-        /**
-         * name: feed -> feed.xml / feed.atom / feed.json
-         * @default '' -> feed.xml / atom.xml / feed.json
-         */
-        name: string;
-        favicon: string;
-    };
-    /**
-     * 社交链接
-     */
-    social: SocialLink[];
-    /**
-     * search
-     */
-    search: {
-        enable: boolean;
-        algolia: AlgoliaSearchOptions;
-    };
-    /**
-     * comment: waline/...
-     */
-    comment: {
-        enable: boolean;
-        waline: {
-            enable: boolean;
-            serverURL: string;
-        };
-        twikoo: {
-            enable: boolean;
-            envId: string;
-        };
-    };
-    /**
-     * Markdown Feature
-     */
-    features: {
-        /**
-         * enable katex for global
-         */
-        katex: boolean;
-    };
-    /**
-     * third-party plugin need cdn
-     * aplayer, twikoo
-     * @default 'https://npm.elemecdn.com/'
-     */
-    cdn: {
-        prefix: string;
-    };
-    /**
-     * The name of theme
-     * @description 主题名称
-     */
-    theme: string;
-    /**
-     * The config of theme
-     * @description 主题配置
-     */
-    themeConfig: T & {
-        pkg: {
-            name: string;
-            version: string;
-            homepage?: string;
-            [key: string]: any;
-        };
-    };
-    /**
-     * The license of your posts
-     * @description 文章所使用的协议，默认使用 Creative Commons
-     * @default https://creativecommons.org/licenses/
-     */
-    license: {
-        /**
-         * Whether to show at the bottom of the article
-         * @description 是否显示在文章底部
-         * @default true
-         */
-        enabled: boolean;
-        /**
-         * Creative License Language, same with your config.lang
-         * when lang === 'zh-CN', use 'zh'
-         * @description 默认与站点语言相同
-         * @default 'en'
-         */
-        language: string;
-        /**
-         * Type of license
-         * @description 证书类型
-         * @default 'by-nc-sa'
-         */
-        type: 'zero' | 'by-sa' | 'by-nd' | 'by-nc' | 'by-nc-sa' | 'by-nc-nd';
-    };
-    /**
-     * donate for author
-     * @description 打赏/赞助
-     */
-    sponsor: {
-        enable: boolean;
-        title: string;
-        methods: {
-            name: string;
-            url: string;
-            color: string;
-            icon: string;
-        }[];
-    };
-    /**
-     * for markdown
-     */
-    markdownIt: MarkdownOptions;
-}
-declare type PartialDeep<T> = {
-    [P in keyof T]?: T[P] extends object ? PartialDeep<T[P]> : T[P];
-};
-/**
- * Valaxy User Config
- * @description Valaxy 用户配置
- */
-declare type UserConfig<ThemeConfig = ValaxyThemeConfig> = PartialDeep<ValaxyConfig<ThemeConfig>>;
-
-interface Post extends Record<string, any> {
-    /**
-     * Path of post
-     * route.path
-     * @description 路径
-     */
-    path?: string;
-    /**
-     * Title
-     * @description 文章标题
-     */
-    title?: string;
-    date?: string | number | Date;
-    /**
-     * Updated Time
-     */
-    updated?: string | number | Date;
-    lang?: string;
-    /**
-     * TODO
-     * Read Time
-     * @description 阅读时长
-     */
-    duration?: string;
-    /**
-     * post card type, can be bilibili/yuque/...
-     */
-    type?: string;
-    /**
-     * override url, and jump directly
-     */
-    url?: string;
-    /**
-     * @description 摘要
-     */
-    excerpt?: string;
-    /**
-     * @description Author
-     * @description:zh-CN 作者
-     */
-    author?: string;
-    /**
-     * Display sponsor info
-     * @description 是否开启赞助
-     */
-    sponsor?: boolean;
-    /**
-     * Copyright
-     * @description 是否显示文章底部版权信息
-     */
-    copyright?: boolean;
-    /**
-     * Category
-     * @description 分类，若为数组，则按顺序代表多层文件夹
-     */
-    categories?: string | string[];
-    /**
-     * Tags
-     * @description 标签，可以有多个
-     */
-    tags?: string[];
-    /**
-     * display prev next
-     * @description 是否显示前一篇、后一篇导航
-     */
-    nav?: boolean;
-    /**
-     * icon before title
-     */
-    icon?: string;
-    /**
-     * title color
-     */
-    color?: string;
-    /**
-     * display comment
-     */
-    comment?: boolean;
-    /**
-     * post is end
-     * @description 是否完结，将在末尾添加衬线字体 Q.E.D.
-     */
-    end?: boolean;
-    /**
-     * use aplayer
-     */
-    aplayer?: boolean;
-    /**
-     * use katex
-     */
-    katex?: boolean;
-    /**
-     * use codepen
-     */
-    codepen?: boolean;
-    /**
-     * 置顶
-     */
-    top?: number;
-    /**
-     * display toc
-     * @description 是否显示目录
-     */
-    toc?: boolean;
-    /**
-     * is draft
-     * @description 是否为草稿
-     */
-    draft?: boolean;
-    /**
-     * cover
-     * @description 封面图片
-     */
-    cover?: string;
-    /**
-     * enable markdown-body class
-     * @description 是否启用默认的 markdown 样式
-     */
-    markdown?: boolean;
-}
-
-interface Header {
-    level: number;
-    title: string;
-    slug: string;
-    /**
-     * i18n
-     */
-    lang?: string;
-}
-interface PageData {
-    path: string;
-    relativePath: string;
-    title: string;
-    titleTemplate?: string;
-    description: string;
-    headers: Header[];
-    frontmatter: Post;
-    lastUpdated?: number;
-}
-interface PageDataPayload {
-    path: string;
-    pageData: PageData;
-}
-declare type HeadConfig = [string, Record<string, string>] | [string, Record<string, string>, string];
-
-declare module 'vite' {
-    interface UserConfig {
-        /**
-         * Custom internal plugin options for Valaxy (advanced)
-         *
-         * @see ./options.ts'
-         */
-        valaxy?: ValaxyPluginOptions;
-        ssgOptions?: ViteSSGOptions;
-    }
-}
-
-export { AlgoliaSearchOptions as A, Header as H, PartialDeep as P, ResolvedValaxyOptions as R, SocialLink as S, UserConfig as U, ValaxyConfig as V, ValaxyEntryOptions as a, ValaxyThemeConfig as b, ValaxyServerOptions as c, ValaxyPluginOptions as d, resolvePluginOptions as e, Post as f, getThemeRoot as g, PageData as h, isPath as i, PageDataPayload as j, HeadConfig as k, resolveOptions as r };