valaxy 0.1.0 → 0.2.0

package/dist/config-24b4f209.d.ts

@@ -0,0 +1,188 @@
+import { PartialDeep } from 'type-fest';
+import { VitePluginConfig } from 'unocss/vite';
+import MarkdownIt from 'markdown-it';
+import Anchor from 'markdown-it-anchor';
+import { KatexOptions } from 'katex';
+import Markdown from 'vite-plugin-md';
+
+interface MarkdownOptions extends MarkdownIt.Options {
+    config?: (md: MarkdownIt) => void;
+    anchor?: {
+        permalink?: Anchor.AnchorOptions['permalink'];
+    };
+    toc?: any;
+    katex?: KatexOptions;
+}
+
+declare type ViteMdOptions = Parameters<typeof Markdown>[0];
+
+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 ValaxyConfig<T = ValaxyThemeConfig> {
+    /**
+     * Default language
+     * @description 默认语言
+     * @default 'en'
+     */
+    lang: string;
+    /**
+     * You site url in web, required for ssg & rss
+     * @description 站点的 URL，SSG & RSS 需要（譬如生成版权处文章永久链接）
+     */
+    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;
+        };
+    };
+    feed: {
+        /**
+         * name: feed -> feed.xml / feed.atom / feed.json
+         * @default '' -> feed.xml / atom.xml / feed.json
+         */
+        name: string;
+        favicon: string;
+    };
+    /**
+     * 社交链接
+     */
+    social: SocialLink[];
+    /**
+     * search
+     */
+    search: {
+        algolia: {
+            enable: boolean;
+            appId: string;
+            apiKey: string;
+            indexName: string;
+            chunkSize: number;
+        };
+    };
+    /**
+     * comment: waline/...
+     */
+    comment: {
+        waline: {
+            enable: boolean;
+            serverURL: string;
+        };
+        twikoo: {
+            enable: boolean;
+            envId: string;
+        };
+    };
+    /**
+     * The name of theme
+     * @description 主题名称
+     */
+    theme: string;
+    /**
+     * The config of theme
+     * @description 主题配置
+     */
+    themeConfig: T;
+    /**
+     * Unocss Config
+     */
+    unocss: VitePluginConfig;
+    /**
+     * 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
+     */
+    markdown: ViteMdOptions;
+    markdownIt: MarkdownOptions;
+}
+/**
+ * Valaxy User Config
+ * @description Valaxy 用户配置
+ */
+declare type UserConfig<T = ValaxyThemeConfig> = PartialDeep<ValaxyConfig<T>>;
+declare const defaultValaxyConfig: ValaxyConfig;
+
+export { SocialLink as S, UserConfig as U, ValaxyConfig as V, ValaxyThemeConfig as a, defaultValaxyConfig as d };

package/dist/index.d.ts

@@ -1,203 +1,368 @@
-import * as vite from 'vite';
-import { InlineConfig } from 'vite';
-import { VitePluginConfig } from 'unocss/vite';
-import MarkdownIt from 'markdown-it';
-import Anchor from 'markdown-it-anchor';
-import { KatexOptions } from 'katex';
-import Markdown from 'vite-plugin-md';
-
-interface MarkdownOptions extends MarkdownIt.Options {
-    config?: (md: MarkdownIt) => void;
-    anchor?: {
-        permalink?: Anchor.AnchorOptions['permalink'];
-    };
-    toc?: any;
-    katex?: KatexOptions;
-}
+import * as vue from 'vue';
+import { InjectionKey, ComputedRef, StyleValue, Ref } from 'vue';
+import { V as ValaxyConfig, a as ValaxyThemeConfig } from './config-24b4f209.js';
+export { S as SocialLink, U as UserConfig, V as ValaxyConfig, a as ValaxyThemeConfig, d as defaultValaxyConfig } from './config-24b4f209.js';
+import 'type-fest';
+import 'unocss/vite';
+import 'markdown-it';
+import 'markdown-it-anchor';
+import 'katex';
+import 'vite-plugin-md';
 
-declare type ViteMdOptions = Parameters<typeof Markdown>[0];
-
-declare type ValaxyThemeConfig = Record<string, any>;
-interface SocialLink {
+interface Post {
     /**
-     * The title of your link
+     * Path of post
+     * route.path
+     * @description 路径
      */
-    name: string;
-    link: string;
+    path?: string;
     /**
-     * 图标名称
-     * https://icones.js.org/
+     * Title
+     * @description 文章标题
      */
-    icon: string;
-    color: string;
-}
-interface ValaxyConfig<T = ValaxyThemeConfig> {
+    title?: string;
+    date?: string | number | Date;
     /**
-     * Default language
-     * @description 默认语言
-     * @default 'en'
+     * Updated Time
      */
-    lang: string;
+    updated?: string | number | Date;
+    lang?: string;
     /**
-     * You site url in web, required for ssg, do not add / in end
-     * @description 站点的 URL，SSG 需要（譬如生成版权处文章永久链接），不要在末尾添加 /
+     * TODO
+     * Read Time
+     * @description 阅读时长
      */
-    url: string;
+    duration?: string;
     /**
-     * Site title
-     * @description 站点标题
+     * post card type, can be bilibili/yuque/...
      */
-    title: string;
+    type?: string;
     /**
-     * 副标题
+     * override url, and jump directly
      */
-    subtitle: string;
+    url?: string;
     /**
-     * 站点描述
+     * @description 摘要
      */
-    description: string;
+    excerpt?: string;
     /**
-     * The owner of this blog
-     * @description 博客作者
+     * Display sponsor info
+     * @description 是否开启赞助
      */
-    author: {
-        /**
-         * Your name
-         * @description 你的名字
-         */
-        name: string;
-        avatar: string;
-        /**
-         * The status of you
-         * @description 状态
-         */
-        status: {
-            emoji: string;
-            /**
-             * show when hover emoji
-             * @description 当鼠标悬浮在图标上时显示
-             */
-            message: string;
-        };
-    };
+    sponsor?: boolean;
     /**
-     * 社交链接
+     * Copyright
+     * @description 是否显示文章底部版权信息
      */
-    social: SocialLink[];
+    copyright?: boolean;
     /**
-     * search
+     * Category
+     * @description 分类，若为数组，则按顺序代表多层文件夹
      */
-    search: {
-        algolia: {
-            enable: boolean;
-            appId: string;
-            apiKey: string;
-            indexName: string;
-            chunkSize: number;
-        };
-    };
+    categories?: string | string[];
     /**
-     * comment: waline/...
+     * Tags
+     * @description 标签，可以有多个
      */
-    comment: {
-        waline: {
-            enable: boolean;
-            serverURL: string;
-        };
-    };
+    tags?: string[];
     /**
-     * The name of theme
-     * @description 主题名称
+     * display prev next
+     * @description 是否显示前一篇、后一篇导航
      */
-    theme: string;
+    nav?: boolean;
     /**
-     * The config of theme
-     * @description 主题配置
+     * icon before title
      */
-    themeConfig: T;
+    icon?: string;
     /**
-     * Unocss Config
+     * title color
      */
-    unocss: VitePluginConfig;
+    color?: string;
     /**
-     * The license of your posts
-     * @description 文章所使用的协议，默认使用 Creative Commons
-     * @default https://creativecommons.org/licenses/
+     * display comment
      */
-    license: {
-        /**
-         * Whether to show at the bottom of the article
-         * @description 是否显示在文章底部
-         * @default true
-         */
-        enabled: boolean;
+    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;
+}
+
+/**
+ * Theme Config
+ */
+interface ThemeConfig {
+    colors: {
         /**
-         * Creative License Language, same with your config.lang
-         * when lang === 'zh-CN', use 'zh'
-         * @description 默认与站点语言相同
-         * @default 'en'
+         * primary color
+         * @default '#0078E7'
          */
-        language: string;
+        primary: string;
+    };
+    /**
+     * 首页标语
+     */
+    banner: {
+        enable: boolean;
         /**
-         * Type of license
-         * @description 证书类型
-         * @default 'by-nc-sa'
+         * 标题
          */
-        type: 'zero' | 'by-sa' | 'by-nd' | 'by-nc' | 'by-nc-sa' | 'by-nc-nd';
+        title: string;
+    };
+    bg_image: {
+        enable: boolean;
+        url: string;
+        dark?: string;
+        opacity: number;
     };
     /**
-     * donate for author
-     * @description 打赏/赞助
+     * say something
+     * https://say.elpsy.cn
      */
-    sponsor: {
+    say: {
         enable: boolean;
-        title: string;
-        methods: {
+        api: string;
+        hitokoto: {
+            enable: boolean;
+            api: string;
+        };
+    };
+    pages: {
+        name: string;
+        url: string;
+        icon: string;
+        color: string;
+    }[];
+    /**
+     * footer
+     */
+    footer: {
+        /**
+         * 建站于
+         */
+        since: number;
+        /**
+         * Icon between year and copyright info.
+         */
+        icon: {
+            /**
+             * icon name, i-xxx
+             */
             name: string;
-            url: string;
+            animated: boolean;
             color: string;
-            icon: string;
-        }[];
+            url: string;
+            title: string;
+        };
+        /**
+         * Powered by valaxy & valaxy-theme-${name}, default is yun
+         */
+        powered: boolean;
+        /**
+         * Chinese Users | 中国用户
+         * 备案 ICP
+         * 国内用户需要在网站页脚展示备案 ICP 号
+         * https://beian.miit.gov.cn/
+         */
+        beian: {
+            enable: boolean;
+            /**
+             * 苏ICP备xxxxxxxx号
+             */
+            icp: string;
+        };
     };
     /**
-     * for markdown
+     * post card types
      */
-    markdown: ViteMdOptions;
-    markdownIt: MarkdownOptions;
+    types: Record<string, {
+        color: string;
+        icon: string;
+    }>;
 }
 
-interface ResolvedValaxyOptions {
-    /**
-     * Client root path
-     * @default 'valaxy/src/client'
-     */
-    clientRoot: string;
-    /**
-     * User root path
-     * @default process.cwd()
-     */
-    userRoot: string;
-    /**
-     * Theme root path
-     */
-    themeRoot: string;
-    /**
-     * Theme name
-     */
-    theme: string;
+declare const valaxyConfigSymbol: InjectionKey<ComputedRef<ValaxyConfig<ThemeConfig>>>;
+declare const valaxyConfigRef: vue.ShallowRef<ValaxyConfig<ValaxyThemeConfig>>;
+declare function initConfig(): ComputedRef<ValaxyConfig<ValaxyThemeConfig>>;
+declare function useConfig(): ComputedRef<ValaxyConfig<ThemeConfig>>;
+/**
+ * getThemeConfig
+ * @returns
+ */
+declare function useThemeConfig(): ComputedRef<ThemeConfig>;
+
+interface ParentCategory {
+    total: number;
+    children: Categories;
+}
+interface PostCategory {
+    total: number;
+    posts: Post[];
+}
+declare type Category = ParentCategory | PostCategory;
+declare type Categories = Map<string, Category>;
+/**
+ * get categories from posts
+ * @returns
+ */
+declare function useCategory(): ParentCategory;
+
+/**
+ * get post list
+ * todo: use vue provide/inject to global
+ * @param params
+ * @returns
+ */
+declare function usePostList(params?: {
+    type?: string;
+}): vue.ComputedRef<Post[]>;
+/**
+ * get prev and next post
+ * @param path
+ * @returns
+ */
+declare function usePrevNext(path?: string): vue.ComputedRef<Post | null>[];
+/**
+ * get type card property
+ * todo: test reactive
+ */
+declare function usePostProperty(type?: string): {
+    color: string;
+    icon: string;
+    styles: {};
+} | {
+    color: string;
+    icon: string;
+    styles: vue.ComputedRef<StyleValue>;
+};
+
+declare type Tags = Map<string, {
+    count: number;
+}>;
+/**
+ * get utils about tags
+ */
+declare function useTags(options?: {
     /**
-     * Valaxy Config
+     * Primary Color
      */
-    config: ValaxyConfig;
+    primary: string;
+}): {
+    tags: Tags;
+    getTagStyle: (count: number) => {
+        '--yun-tag-color': string;
+        fontSize: string;
+    };
+};
+/**
+ * get tag map
+ * @returns
+ */
+declare function useTag(): Tags;
+
+declare function useFrontmatter(): vue.ComputedRef<Post>;
+/**
+ * get full url
+ */
+declare function useFullUrl(): vue.ComputedRef<string>;
+
+/**
+ * use katex css cdn
+ */
+declare function useKatex(): void;
+
+/**
+ * trigger show invisible element
+ * @param target
+ * @returns
+ */
+declare function useInvisibleElement(target: Ref<HTMLElement>): {
+    show: () => void;
+};
+
+declare const isDark: vue.WritableComputedRef<boolean>;
+declare const toggleDark: (value?: boolean | undefined) => boolean;
+
+declare function useLayout(layout: string): vue.ComputedRef<boolean>;
+
+/**
+ * use MetingJS and Aplayer
+ * https://github.com/MoePlayer/APlayer
+ * https://github.com/metowolf/MetingJS
+ */
+declare function useAplayer(): void;
+
+/**
+ * You can use href="#" to back to top
+ * @description 你可以使用它来编写自己的 backToTop
+ */
+declare function useBackToTop(options?: {
     /**
-     * config file path
+     * show backToTop button, when height > offset
      */
-    configFile: string;
-}
-interface ValaxyServerOptions {
-    onConfigReload?: (newConfig: ValaxyConfig, config: ValaxyConfig) => void;
-}
+    offset: number;
+}): {
+    percentage: vue.Ref<number>;
+    show: vue.Ref<boolean>;
+};
+
+declare function useCodePen(): void;
+
+declare function useActiveSidebarLinks(): void;
+
+declare function useTwikoo(options?: {}): void;
+
+declare function useWaline(options?: {}): void;
+
+/**
+ * 生成介于 min 与 max 之间的随机数
+ * @returns
+ */
+declare function random(min: number, max: number): number;
+/**
+ * wrap node
+ * @param className
+ */
+declare function wrap(el: HTMLElement, className: string): void;
+/**
+ * 包裹表格，添加 class 以控制 table 样式
+ */
+declare const wrapTable: (container?: HTMLElement | Document) => void;
 
-declare function createServer(options: ResolvedValaxyOptions, viteConfig?: InlineConfig, serverOptions?: ValaxyServerOptions): Promise<vite.ViteDevServer>;
+/**
+ * use dayjs format date
+ * @param date
+ * @param template
+ * @returns
+ */
+declare function formatDate(date: string | number | Date, template?: string): string;
+/**
+ * sort posts by date
+ * @param posts
+ * @param desc
+ */
+declare function sortByDate(posts: Post[], desc?: boolean): Post[];
 
-export { createServer };
+export { Categories, Category, ParentCategory, Post, PostCategory, Tags, formatDate, initConfig, isDark, random, sortByDate, toggleDark, useActiveSidebarLinks, useAplayer, useBackToTop, useCategory, useCodePen, useConfig, useFrontmatter, useFullUrl, useInvisibleElement, useKatex, useLayout, usePostList, usePostProperty, usePrevNext, useTag, useTags, useThemeConfig, useTwikoo, useWaline, valaxyConfigRef, valaxyConfigSymbol, wrap, wrapTable };