valaxy 0.26.2 → 0.26.3

package/dist/types/index.d.mts

@@ -1,778 +1,12 @@
-import { V as ValaxyAddon, D as DefaultTheme } from '../shared/valaxy.D_ue8jlC.mjs';
-import { FuseOptions } from '@vueuse/integrations/useFuse';
-import { ZoomOptions } from 'medium-zoom';
-import { ILazyLoadOptions } from 'vanilla-lazyload';
-import { RouteRecordRaw } from 'vue-router';
-import { NodeRelations, ImageObject } from '@unhead/schema-org';
+import { c as PostFrontMatter, d as PageFrontMatter } from '../shared/valaxy.BwiZu4ms.mjs';
+export { A as Album, B as BaseFrontMatter, D as DefaultTheme, E as ExcerptType, F as FuseListItem, P as PartialDeep, i as Photo, g as Pkg, a as RedirectItem, f as RedirectRule, R as RuntimeConfig, S as SiteConfig, e as SocialLink, U as UserSiteConfig, h as UserValaxyConfig, b as ValaxyAddon, V as ValaxyConfig } from '../shared/valaxy.BwiZu4ms.mjs';
 import { Header } from '@valaxyjs/utils';
+import '@vueuse/integrations/useFuse';
+import 'medium-zoom';
+import 'vanilla-lazyload';
+import 'vue-router';
 import '@vueuse/core';
-
-interface CollectionConfig {
-    title?: string;
-    key?: string;
-    /**
-     * if key is not provided, path is required
-     *
-     * if key is provided, path = `/collections/${key}`
-     */
-    path?: string;
-    /**
-     * @en
-     * The name of the collection.
-     *
-     * @zh
-     * 合集名称
-     */
-    name?: string;
-    cover?: string;
-    description?: string;
-    categories?: string[];
-    tags?: string[];
-    /**
-     * items
-     */
-    items?: {
-        title?: string;
-        /**
-         * 合集文章的唯一索引
-         *
-         * 对应路径为 `/collections/${key}/${item.key}`
-         */
-        key?: string;
-    }[];
-}
-
-interface Album {
-    /**
-     * @description:en-US Album Link
-     */
-    url: string;
-    /**
-     * @description:en-US Album cover
-     * url
-     */
-    cover: string;
-    /**
-     * @description:en-US Album caption
-     */
-    caption: string;
-    /**
-     * @description:en-US Album description
-     */
-    desc: string;
-}
-interface Photo {
-    src: string;
-    caption: string;
-    desc: string;
-}
-interface BaseFrontMatter extends Record<string, any> {
-    /**
-     * Title
-     * @description 文章标题
-     *
-     * ```md
-     * ---
-     * title: Post Title
-     * ---
-     * ```
-     *
-     * i18n:
-     *
-     * ```md
-     * ---
-     * title:
-     *   en: Post Title
-     *   zh-CN: 文章标题
-     * ---
-     * ```
-     */
-    title: string | Record<string, string>;
-    /**
-     * @description:en-US Created Date
-     * @description:zh-CN 文章创建日期
-     */
-    date: string | number | Date;
-    /**
-     * Updated Time
-     */
-    updated: string | number | Date;
-}
-interface PageFrontMatter extends BaseFrontMatter {
-    /**
-     * Path of post
-     * route.path
-     * @description 路径
-     */
-    path: string;
-    /**
-     * abbrlink
-     *
-     * generated by valaxy-addon-abbrlink, do not manually modify
-     *
-     * just compatible for [hexo-abbrlink](https://github.com/ohroy/hexo-abbrlink)
-     */
-    abbrlink: string;
-    /**
-     * i18n
-     */
-    lang: string;
-    /**
-     * @description Author
-     * @description:zh-CN 作者
-     */
-    author: string;
-    /**
-     * Display sponsor info
-     * @description 是否开启赞助
-     */
-    sponsor: boolean;
-    /**
-     * Copyright
-     * @description 是否显示文章底部版权信息
-     */
-    copyright: boolean;
-    /**
-     * for seo
-     * schema
-     */
-    image: NodeRelations<ImageObject | string>;
-    /**
-     * cover
-     * @description 封面图片
-     */
-    cover: string;
-    /**
-     * display toc
-     * @description 是否显示目录
-     */
-    toc: boolean;
-    /**
-     * display right sidebar
-     * @description 是否显示右侧侧边栏
-     */
-    aside: boolean;
-    /**
-     * display left sidebar
-     * @description 是否显示左侧侧边栏
-     */
-    sidebar: boolean;
-    /**
-     * @description:en-US Custom Markdown class
-     * @description:zh-CN 自定义 Markdown 样式
-     * @default 'markdown-body'
-     */
-    markdownClass: string;
-    /**
-     * @description:en-US Post title class
-     * @description:zh-CN 文章标题样式
-     */
-    pageTitleClass: string;
-    /**
-     * icon before title
-     * @description 标题前的图标
-     */
-    icon: string;
-    /**
-     * title color
-     * @deprecated Please use `pageTitleClass` | `postTitleClass` instead
-     */
-    color: string;
-    /**
-     * display comment
-     */
-    comment: boolean;
-    /**
-     * post is end
-     * @description 是否完结，将在末尾添加衬线字体 Q.E.D.
-     */
-    end: boolean;
-    /**
-     * use katex
-     * @url https://katex.org/
-     */
-    katex: boolean;
-    /**
-     * use codepen
-     * @url https://codepen.io/
-     */
-    codepen: boolean;
-    /**
-     * use medium-zoom
-     * @url https://github.com/francoischalifour/medium-zoom
-     */
-    medium_zoom: boolean;
-    /**
-     * @description:en-US Albums
-     * @description:zh-CN 相册
-     */
-    albums: Album[];
-    /**
-     * For layout Gallery
-     * @description:en-US Photos
-     */
-    photos: Photo[];
-    /**
-     * for collections
-     */
-    collections: CollectionConfig[];
-    /**
-     * @description:zh-CN 是否启用加密，password 存在时默认为 true
-     */
-    encrypt: boolean;
-    /**
-     * @description:zh-CN 加密密码
-     */
-    password?: string;
-    /**
-     * @description:zh-CN 密码提示
-     */
-    password_hint?: string;
-    /**
-     * @description:zh-CN 相册密码
-     */
-    gallery_password?: string;
-    /**
-     * @en
-     * @description encrypted content
-     *
-     * @description:zh-CN 加密后的内容
-     */
-    encryptedContent?: string;
-    /**
-     * @description:zh-CN 部分加密的内容
-     */
-    partiallyEncryptedContents?: string[];
-    /**
-     * @description:zh-CN 加密后的相册
-     */
-    encryptedPhotos?: string;
-    /**
-     * @description:en-US Limit the height of the code block in px
-     * @description:zh-CN 限制代码块的高度，单位是 px
-     */
-    codeHeightLimit?: number;
-    /**
-     * @description:en-US Source path for client redirection
-     * @description:zh-CN 客户端重定向的源路径
-     */
-    from?: string | string[];
-}
-
-type ExcerptType = 'md' | 'html' | 'text' | 'ai';
-interface PostFrontMatter extends PageFrontMatter {
-    /**
-     * @description:en-US Custom post title class in post list
-     * @description:zh-CN 文章列表中 自定义标题样式
-     */
-    postTitleClass: string;
-    /**
-     * @description:en-US Post Card Type, can be bilibili/yuque/... (need theme support)
-     * @description:zh-CN 卡片类型，可以是 bilibili/yuque/... (需主题支持)
-     */
-    type: 'bilibili' | 'yuque' | string;
-    /**
-     * @en override url, and jump directly
-     * @zh 覆盖 post url，直接跳转
-     */
-    url: string;
-    /**
-     * @description:en-US custom excerpt, `excerpt_type` will be invalid
-     * @description 手动指定摘要，此时 `excerpt_type` 将会无效
-     */
-    excerpt: string;
-    /**
-     * @description 摘要类型
-     * @default 'html'
-     * render type of excerpt
-     * - md: render as raw markdown
-     * - html: render as html
-     * - text: render as text
-     */
-    excerpt_type: 'md' | 'text' | 'html' | 'ai';
-    /**
-     * @description:en-US Category, if it is an array, it represents multiple folders in order
-     * @description:zh-CN 分类，若为数组，则按顺序代表多层文件夹
-     */
-    categories: string | string[];
-    /**
-     * @description:en-US Tags, can have multiple
-     * @description:zh-CN 标签，可以有多个
-     */
-    tags: string[];
-    /**
-     * @description:en-US Whether to display the previous and next navigation
-     * @description:zh-CN 是否显示前一篇、后一篇导航
-     */
-    nav: boolean;
-    /**
-     * @description:en-US Pin to top, the larger the number, the closer to the front
-     * @description:zh-CN 置顶，数字越大越靠前
-     */
-    top: number;
-    /**
-     * @description:en-US Whether it is a draft, it will only be displayed during development
-     * @description:zh-CN 是否为草稿，将仅在开发时被展示
-     */
-    draft: boolean;
-    /**
-     * hide in index
-     * - true/`all`: hide in index & archive
-     * - `index`: hide in index
-     * @description 是否隐藏
-     */
-    hide: 'index' | boolean;
-    /**
-     * @en
-     * when the post is updated more than 30 days ago, show a warning
-     * default 30 days, you can set `time_warning` in frontmatter to change it
-     *
-     * @zh
-     * 当文章更新时间超过 30 天时，显示一个警告
-     * 默认 30 天，你可以在 frontmatter 中设置 `time_warning` （数字）来修改，单位 ms
-     * @example 3600000
-     */
-    time_warning: boolean | number;
-    /**
-     * @protected
-     * @see https://valaxy.site/guide/config/#%E9%98%85%E8%AF%BB%E7%BB%9F%E8%AE%A1
-     * @tutorial ⚠️ DO NOT SET MANUALLY (generated by `site.config.ts` -> `statistics.enable: true`)
-     * You can use `statistics.readTime.speed` to change the speed of reading time.
-     * @description:en-US Reading time
-     * @description:zh-CN 阅读时间
-     */
-    readingTime: number;
-    /**
-     * @protected
-     * @see https://valaxy.site/guide/config/#%E9%98%85%E8%AF%BB%E7%BB%9F%E8%AE%A1
-     * @tutorial ⚠️ DO NOT SET MANUALLY (generated by `site.config.ts` -> `statistics.enable: true`)
-     * You need enable `statistics` in site config to use this feature.
-     * @description:en-US Word count
-     * @description:zh-CN 字数统计
-     */
-    wordCount: string;
-}
-
-interface FuseListItem extends Record<string, any> {
-    title: string | Record<string, string>;
-    excerpt?: string;
-    author: string;
-    tags: string[];
-    categories: string[];
-    link: string;
-    content?: string;
-}
-
-/**
- * @zh 社交链接
- */
-interface SocialLink {
-    /**
-     * The title of your link
-     */
-    name: string;
-    link: string;
-    /**
-     * 图标名称
-     * https://icones.js.org/
-     */
-    icon: string;
-    /**
-     * @zh 图标颜色
-     */
-    color: string;
-}
-interface RedirectRule {
-    to: string;
-    from: string | string[];
-}
-interface RedirectItem {
-    from: string;
-    to: string;
-}
-interface SiteConfig {
-    /**
-     * enable auto (light/dark mode)
-     * @default 'auto'
-     */
-    mode: 'light' | 'dark' | 'auto';
-    /**
-     * Default language
-     * @description 默认语言，设置 `zh-CN` 以改变默认语言为中文
-     * @default 'en'
-     */
-    lang: string;
-    /**
-     * alternative languages
-     * @description 可选语言
-     * @en If you want to disable multi-language support for your site, you can set this to only include one language (e.g. `['en']`)
-     * @zh 如果你想要禁言站点的多语言支持，可以将此项设置为仅包含一个语言 (例如 `['zh-CN']`)
-     * @default ['en', 'zh-CN']
-     * @see https://ogp.me/#optional
-     */
-    languages: string[];
-    /**
-     * You site url in web, required for ssg & rss
-     * @description 站点的完整 URL，SSG & RSS 需要（譬如生成版权处文章永久链接）
-     * @example 'https://valaxy.site'
-     * @default '/'
-     */
-    /**
-     * @see https://wikipedia.org/wiki/List_of_tz_database_time_zones
-     * @en_US Timezone configuration
-     * @zh_CN 时区配置，国内推荐使用 'Asia/Shanghai'
-     * @description:en-US This configuration is used to generate times with timezone when no timezone is set
-     * @description:zh-CN 当时间没有设置时区时，使用该配置生成带时区的时间
-     * @default ''
-     */
-    timezone: string;
-    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 representation of your status like '👨‍💻'
-             * @description 你的状态的 Emoji 表示，如 '👨‍💻'
-             */
-            emoji: string;
-            /**
-             * show when hover emoji
-             * @description 当鼠标悬浮在图标上时显示
-             */
-            message: string;
-        };
-        /**
-         * @zh 个人简介
-         */
-        intro?: string;
-    };
-    /**
-     * show last updated time by git/mtime
-     */
-    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[];
-    /**
-     * @en search engine for your site
-     * @zh 搜索功能
-     */
-    search: {
-        /**
-         * @zh 是否启用
-         */
-        enable: boolean;
-        /**
-         * Search Type
-         * - algolia: Algolia Search
-         * - engine: Engine Search, like Google/Baidu
-         * - fuse: Local Search by fuse.js
-         */
-        type: 'algolia' | 'engine' | 'fuse';
-    };
-    /**
-     *
-     * fuse search
-     * @see https://fusejs.io/
-     * @description 本地搜索
-     * Please set search.type to 'fuse'
-     */
-    fuse: {
-        /**
-         * @default 'valaxy-fuse-list.json'
-         * @description 搜索结果列表数据所在路径
-         */
-        dataPath: string;
-        /**
-         * fast-glob pattern to match Fuse List Data
-         * @default `pages\/**\/*.md`
-         * ```ts
-         * await fg(`${userRoot}/pages/posts/**\/*.md`)
-         * ```
-         */
-        pattern?: string;
-        /**
-         * @see https://fusejs.io/api/options.html
-         */
-        options: FuseOptions<FuseListItem> & {
-            /**
-             * @en_US The fields to be searched.
-             * @zh_CN 搜索的字段
-             * @default ['title', 'tags', 'categories', 'excerpt']
-             * @description:en-US List of keys that will be searched. This supports nested paths, weighted search, and searching in arrays of strings and objects
-             * @description:zh-CN 搜索将会涉及的字段列表，支持嵌套路径、加权搜索以及在字符串和对象数组中进行搜索
-             * @see https://fusejs.io/api/options.html#keys
-             */
-            keys: FuseOptions<FuseListItem>['keys'];
-        };
-    };
-    /**
-     * set post default frontmatter
-     */
-    frontmatter: Partial<PostFrontMatter>;
-    /**
-     * comment: waline/...
-     */
-    comment: {
-        enable: boolean;
-    };
-    /**
-     * third-party plugin need cdn
-     * aplayer, twikoo
-     * @default 'https://unpkg.com/'
-     */
-    cdn: {
-        /**
-         * prefix for your third-party
-         * @default 'https://unpkg.com/'
-         */
-        prefix: string;
-    };
-    /**
-     * 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;
-        /**
-         * Donate button title attribute
-         * @description 打赏按钮的 title 属性
-         * @default zh:'打赏' en:'Donate'
-         */
-        title?: string;
-        /**
-         * Donate content description
-         * @description 打赏的描述内容，在按钮下方所有图片上方，与图片一起折叠
-         * @default undefined 不显示内容
-         */
-        description?: string;
-        /**
-         * @zh 赞助方式
-         */
-        methods: {
-            name: string;
-            url: string;
-            color: string;
-            icon: string;
-        }[];
-    };
-    /**
-     * image preview by medium-zoom
-     * @url https://github.com/francoischalifour/medium-zoom
-     */
-    mediumZoom: {
-        /**
-         * @zh 启用图片预览
-         */
-        enable: boolean;
-        /**
-         * For example: '.markdown-body img'
-         * @default '' content.value querySelectorAll('img')
-         */
-        selector: string | HTMLElement | HTMLElement[];
-        /**
-         * @zh 配置项
-         * @see https://github.com/francoischalifour/medium-zoom#options
-         */
-        options: ZoomOptions;
-    };
-    /**
-     * lazyload by vanilla-lazyload and markdown-it-image-figures
-     * when vanillaLazyLoad.enable is true, imageFigures removeSrc is true, classes is 'lazy'
-     * @see https://github.com/verlok/vanilla-lazyload
-     */
-    vanillaLazyload: {
-        enable: boolean;
-        options: ILazyLoadOptions;
-    };
-    /**
-     * Floating Vue configuration for floating footnote tooltips.
-     * @see https://floating-vue.starpad.dev/guide/config
-     */
-    floatingVue: any;
-    /**
-     * displayed posts length in every page
-     * @default 7
-     */
-    pageSize: number;
-    /**
-     * statistics readingTime and wordCount
-     * @description 统计阅读时间和字数
-     */
-    statistics: {
-        enable: boolean;
-        readTime: {
-            speed: {
-                /**
-                 * Chinese word count speed
-                 * @description 中文每分钟阅读字数
-                 * @default 300 (300 字/分钟)
-                 */
-                cn: number;
-                /**
-                 * English word count speed
-                 * @description 英文每分钟阅读字数
-                 * @default 100 (200 字/分钟)
-                 */
-                en: number;
-            };
-        };
-    };
-    /**
-     * @description Encrypt article
-     * @description:zh-CN 加密文章
-     * default algorithm: AES-CBC
-     */
-    encrypt: {
-        enable: boolean;
-        /**
-         * [encrypt](https://developer.mozilla.org/zh-CN/docs/Web/API/SubtleCrypto/encrypt#%E6%94%AF%E6%8C%81%E7%9A%84%E7%AE%97%E6%B3%95)
-         * @default AES-CBC
-         */
-        algorithm: string;
-        iv: Uint8Array;
-        salt: Uint8Array;
-    };
-    /**
-     * @description:en-US Limit the height of the code block in px
-     * @description:zh-CN 限制代码块的高度，单位是 px
-     */
-    codeHeightLimit?: number;
-    /**
-     * @description:en-US client redirect rules
-     * @description:zh-CN 客户端重定向规则
-     */
-    redirects?: {
-        useVueRouter?: boolean;
-        rules?: RedirectRule[];
-    };
-}
-type PartialDeep<T> = {
-    [P in keyof T]?: T[P] extends object ? PartialDeep<T[P]> : T[P];
-};
-/**
- * config generated by runtime
- */
-interface RuntimeConfig {
-    addons: Record<string, ValaxyAddon>;
-    redirects: {
-        useVueRouter: boolean;
-        redirectRoutes: RouteRecordRaw[];
-    };
-}
-interface Pkg {
-    name: string;
-    version: string;
-    homepage?: string;
-    [key: string]: any;
-}
-interface ValaxyConfig<ThemeConfig = DefaultTheme.Config> {
-    /**
-     * @en Site **info** config. This affects info displayed on the site, and is independent of themes.
-     * @zh 站点**信息**配置，这部分内容面向站点展示，且在不同主题中也是通用的格式
-     * @see [站点配置 | Valaxy](https://valaxy.site/guide/config#%E7%AB%99%E7%82%B9%E9%85%8D%E7%BD%AE)
-     * @see [Site Config | Valaxy](https://valaxy.site/guide/config#site-config)
-     */
-    siteConfig: SiteConfig;
-    /**
-     * The name of theme
-     * @description 主题名称
-     * @see 主题橱窗 [Valaxy Themes Gallery](https://valaxy.site/themes/gallery)
-     * @see 如何编写主题？ [How to write a theme? | Valaxy](https://valaxy.site/themes/write)
-     * @see [默认 Yun 主题示例](https://yun.valaxy.site/)
-     */
-    theme: string;
-    /**
-     * The config of theme
-     * @zh 请参考对应主题的相关文档
-     * @description 主题配置
-     * @see [默认 Yun 主题文档](https://github.com/YunYouJun/valaxy/blob/main/packages/valaxy-theme-yun/docs/README.md)
-     */
-    themeConfig: ThemeConfig & {
-        pkg: Pkg;
-    };
-    /**
-     * @en Generated in runtime, do not modify manually
-     * @zh 在运行时生成，请勿手动修改
-     */
-    runtimeConfig: RuntimeConfig;
-}
-/**
- * user site config
- */
-type UserSiteConfig = PartialDeep<SiteConfig>;
-/**
- * Valaxy User Config
- * @description Valaxy 用户配置
- */
-type UserValaxyConfig<ThemeConfig = DefaultTheme.Config> = PartialDeep<ValaxyConfig<ThemeConfig>>;
+import '@unhead/schema-org';
 
 type Page = Partial<PageFrontMatter>;
 type Post = Partial<PostFrontMatter>;
@@ -798,5 +32,5 @@ interface PageDataPayload {
 }
 type HeadConfig = [string, Record<string, string>] | [string, Record<string, string>, string];
 
-export { DefaultTheme, ValaxyAddon };
-export type { Album, BaseFrontMatter, CleanUrlsMode, ExcerptType, FuseListItem, HeadConfig, Page, PageData, PageDataPayload, PageFrontMatter, PartialDeep, Photo, Pkg, Post, PostFrontMatter, RedirectItem, RedirectRule, RuntimeConfig, SiteConfig, SocialLink, UserSiteConfig, UserValaxyConfig, ValaxyConfig };
+export { PageFrontMatter, PostFrontMatter };
+export type { CleanUrlsMode, HeadConfig, Page, PageData, PageDataPayload, Post };