valaxy 0.7.7 → 0.8.1

package/dist/node/index.d.ts

@@ -1,26 +1,151 @@
-import { U as UserConfig, V as ValaxyConfig, a as ValaxyEntryOptions, b as ValaxyThemeConfig, R as ResolvedValaxyOptions, c as ValaxyServerOptions } from '../index-df14d281.js';
-export { R as ResolvedValaxyOptions, a as ValaxyEntryOptions, d as ValaxyPluginOptions, c as ValaxyServerOptions, g as getThemeRoot, i as isPath, r as resolveOptions, e as resolvePluginOptions } from '../index-df14d281.js';
-import * as type_fest_source_partial_deep from 'type-fest/source/partial-deep';
+import { ViteSSGOptions } from 'vite-ssg';
+import Vue from '@vitejs/plugin-vue';
+import Components from 'unplugin-vue-components/vite';
+import { VitePluginConfig } from 'unocss/vite';
+import Pages from 'vite-plugin-pages';
+import { V as ValaxyConfig, U as UserConfig, P as PartialDeep, a as ValaxyThemeConfig } from '../config-60c840d8.js';
+import MarkdownIt from 'markdown-it';
+import { Theme } from 'shiki';
+import Anchor from 'markdown-it-anchor';
+import { KatexOptions } from 'katex';
 import * as vite from 'vite';
 import { InlineConfig } from 'vite';
-import 'vite-ssg';
-import '@vitejs/plugin-vue';
-import 'unplugin-vue-components/vite';
-import 'unocss/vite';
-import 'type-fest';
-import 'markdown-it';
-import 'shiki';
-import 'markdown-it-anchor';
-import 'katex';
+
+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 {
+    /**
+     * markdown-it options
+     */
+    options?: MarkdownIt.Options;
+    /**
+     * config markdown-it
+     */
+    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;
+}
+
+interface ValaxyEntryOptions {
+    /**
+     * theme name
+     */
+    theme?: string;
+    userRoot?: string;
+}
+interface ValaxyPluginOptions {
+    vue?: Parameters<typeof Vue>[0];
+    components?: Parameters<typeof Components>[0];
+    unocss?: VitePluginConfig;
+    pages?: Parameters<typeof Pages>[0];
+    /**
+     * for markdown
+     */
+    markdown?: MarkdownOptions;
+    extendMd?: (ctx: {
+        route: any;
+        data: Record<string, any>;
+        excerpt?: string;
+        path: string;
+    }) => void;
+}
+interface ResolvedValaxyOptions {
+    mode: 'dev' | 'build';
+    /**
+     * package.json root
+     */
+    pkgRoot: string;
+    /**
+     * 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>;
+
+declare module 'vite' {
+    interface UserConfig {
+        /**
+         * Custom internal plugin options for Valaxy (advanced)
+         *
+         * @see ./options.ts'
+         */
+        valaxy?: ValaxyPluginOptions;
+        ssgOptions?: ViteSSGOptions;
+    }
+}
 
 /**
  * Type config helper
  */
-declare function defineConfig<ThemeConfig>(config: UserConfig<ThemeConfig>): type_fest_source_partial_deep.PartialObjectDeep<ValaxyConfig<ThemeConfig>>;
+declare function defineConfig<ThemeConfig>(config: UserConfig<ThemeConfig>): PartialDeep<ValaxyConfig<ThemeConfig>>;
 /**
  * Type config helper for custom theme config
  */
-declare function defineConfigWithTheme<ThemeConfig>(config: UserConfig<ThemeConfig>): type_fest_source_partial_deep.PartialObjectDeep<ValaxyConfig<ThemeConfig>>;
+declare function defineConfigWithTheme<ThemeConfig>(config: UserConfig<ThemeConfig>): PartialDeep<ValaxyConfig<ThemeConfig>>;
 declare function resolveConfig(options?: ValaxyEntryOptions): Promise<{
     config: ValaxyConfig<ValaxyThemeConfig>;
     configFile: string;
@@ -29,4 +154,4 @@ declare function resolveConfig(options?: ValaxyEntryOptions): Promise<{
 
 declare function createServer(options: ResolvedValaxyOptions, viteConfig?: InlineConfig, serverOptions?: ValaxyServerOptions): Promise<vite.ViteDevServer>;
 
-export { createServer, defineConfig, defineConfigWithTheme, resolveConfig };
+export { ResolvedValaxyOptions, ValaxyEntryOptions, ValaxyPluginOptions, ValaxyServerOptions, createServer, defineConfig, defineConfigWithTheme, getThemeRoot, isPath, resolveConfig, resolveOptions };

package/dist/node/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkBTP4CLJNjs = require('../chunk-BTP4CLJN.js');exports.createServer = _chunkBTP4CLJNjs.p; exports.defineConfig = _chunkBTP4CLJNjs.e; exports.defineConfigWithTheme = _chunkBTP4CLJNjs.f; exports.getThemeRoot = _chunkBTP4CLJNjs.j; exports.isPath = _chunkBTP4CLJNjs.i; exports.resolveConfig = _chunkBTP4CLJNjs.g; exports.resolveOptions = _chunkBTP4CLJNjs.k; exports.resolvePluginOptions = _chunkBTP4CLJNjs.l;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkVGABMGJAjs = require('../chunk-VGABMGJA.js');exports.createServer = _chunkVGABMGJAjs.n; exports.defineConfig = _chunkVGABMGJAjs.e; exports.defineConfigWithTheme = _chunkVGABMGJAjs.f; exports.getThemeRoot = _chunkVGABMGJAjs.j; exports.isPath = _chunkVGABMGJAjs.i; exports.resolveConfig = _chunkVGABMGJAjs.g; exports.resolveOptions = _chunkVGABMGJAjs.k;

package/dist/node/index.mjs

@@ -1 +1 @@
-import{e as o,f as r,g as e,i as f,j as m,k as p,l as t,p as x}from"../chunk-HP2UOVSL.mjs";export{x as createServer,o as defineConfig,r as defineConfigWithTheme,m as getThemeRoot,f as isPath,e as resolveConfig,p as resolveOptions,t as resolvePluginOptions};
+import{e as o,f as r,g as m,i as p,j as t,k as e,n as f}from"../chunk-ER6SQ4ZW.mjs";export{f as createServer,o as defineConfig,r as defineConfigWithTheme,t as getThemeRoot,p as isPath,m as resolveConfig,e as resolveOptions};

package/dist/types/index.d.ts

@@ -1,10 +1,154 @@
-import 'vite-ssg';
-export { A as AlgoliaSearchOptions, j as HeadConfig, H as Header, f as PageData, h as PageDataPayload, P as Post, S as SocialLink, U as UserConfig, V as ValaxyConfig, b as ValaxyThemeConfig } from '../index-df14d281.js';
-import '@vitejs/plugin-vue';
-import 'unplugin-vue-components/vite';
-import 'unocss/vite';
-import 'type-fest';
-import 'markdown-it';
-import 'shiki';
-import 'markdown-it-anchor';
-import 'katex';
+export { A as AlgoliaSearchOptions, P as PartialDeep, S as SocialLink, U as UserConfig, V as ValaxyConfig, a as ValaxyThemeConfig } from '../config-60c840d8.js';
+
+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;
+    /**
+     * display right sidebar
+     * @description 是否显示右侧侧边栏
+     */
+    aside?: 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];
+
+export { HeadConfig, Header, PageData, PageDataPayload, Post };

package/index.d.ts

@@ -1,5 +1,5 @@
 // re-export @vueuse/shared types. with strict installers like pnpm, user won't
-// be able to reference vite/client in project root.
+// be able to reference @vueuse/shared in project root.
 /// <reference types="@vueuse/shared" />
 
 export * from './client/index'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "valaxy",
-  "version": "0.7.7",
+  "version": "0.8.1",
   "description": "📄 Vite & Vue powered static blog generator.",
   "author": {
     "email": "me@yunyoujun.cn",
@@ -22,11 +22,17 @@
       "import": "./dist/node/index.mjs"
     },
     "./client/*": "./client/*",
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "require": "./dist/client/index.js",
+      "import": "./dist/client/index.mjs"
+    },
     "./node": {
       "types": "./dist/node/index.d.ts",
       "require": "./dist/node/index.js",
       "import": "./dist/node/index.mjs"
     },
+    "./types": "./dist/types/index.d.ts",
     "./*": "./*"
   },
   "main": "dist/node/index.js",
@@ -40,7 +46,8 @@
     "index.d.ts",
     "bin",
     "dist",
-    "client"
+    "client",
+    "types"
   ],
   "engines": {
     "node": ">=14.0.0"
@@ -48,8 +55,6 @@
   "dependencies": {
     "@antfu/utils": "^0.5.2",
     "@ctrl/tinycolor": "^3.4.1",
-    "@docsearch/css": "^3.1.1",
-    "@docsearch/js": "^3.1.1",
     "@iconify-json/carbon": "^1.1.6",
     "@iconify-json/ri": "^1.1.3",
     "@intlify/vite-plugin-vue-i18n": "^3.4.0",
@@ -60,6 +65,7 @@
     "critters": "^0.0.16",
     "cross-spawn": "^7.0.3",
     "dayjs": "^1.11.3",
+    "ejs": "^3.1.8",
     "escape-html": "^1.0.3",
     "feed": "^4.2.2",
     "global-dirs": "^3.0.0",
@@ -83,7 +89,7 @@
     "shiki": "^0.10.1",
     "star-markdown-css": "^0.4.0",
     "unconfig": "^0.3.5",
-    "unocss": "^0.43.2",
+    "unocss": "^0.44.0",
     "unplugin-vue-components": "^0.21.1",
     "vite": "^2.9.14",
     "vite-plugin-inspect": "^0.5.1",
@@ -98,15 +104,15 @@
   },
   "devDependencies": {
     "@types/cross-spawn": "^6.0.2",
+    "@types/ejs": "^3.1.1",
     "@types/katex": "^0.14.0",
-    "@types/lru-cache": "^7.10.10",
+    "@types/markdown-it": "^12.2.3",
     "@types/markdown-it-link-attributes": "^3.0.1",
     "@types/nprogress": "^0.2.0",
     "@types/yargs": "^17.0.10",
     "debug": "^4.3.4",
     "diacritics": "^1.3.0",
-    "https-localhost": "^4.7.1",
-    "type-fest": "^2.16.0"
+    "https-localhost": "^4.7.1"
   },
   "scripts": {
     "build": "rimraf dist && tsup --splitting",

package/types/config.ts

@@ -0,0 +1,218 @@
+export type ValaxyThemeConfig = Record<string, any>
+
+export interface SocialLink {
+  /**
+   * The title of your link
+   */
+  name: string
+  link: string
+  /**
+   * 图标名称
+   * https://icones.js.org/
+   */
+  icon: string
+  color: string
+}
+
+export interface AlgoliaSearchOptions {
+  enable: boolean
+  appId: string
+  apiKey: string
+  indexName: string
+  placeholder?: string
+  searchParameters?: any
+  disableUserPersonalization?: boolean
+  initialQuery?: string
+}
+
+// packages/valaxy/node/config.ts
+export 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
+    }[]
+  }
+}
+
+export type PartialDeep<T> = {
+  [P in keyof T]?: T[P] extends object ? PartialDeep<T[P]> : T[P]
+}
+
+/**
+ * Valaxy User Config
+ * @description Valaxy 用户配置
+ */
+export type UserConfig<ThemeConfig = ValaxyThemeConfig> = PartialDeep<ValaxyConfig<ThemeConfig>>
+

package/types/data.ts

@@ -0,0 +1,31 @@
+import type { Post } from './posts'
+
+export interface Header {
+  level: number
+  title: string
+  slug: string
+  /**
+   * i18n
+   */
+  lang?: string
+}
+
+export interface PageData {
+  path: string
+  relativePath: string
+  title: string
+  titleTemplate?: string
+  description: string
+  headers: Header[]
+  frontmatter: Post
+  lastUpdated?: number
+}
+
+export interface PageDataPayload {
+  path: string
+  pageData: PageData
+}
+
+export type HeadConfig =
+  | [string, Record<string, string>]
+  | [string, Record<string, string>, string]

package/types/index.ts

@@ -0,0 +1,3 @@
+export * from './config'
+export * from './data'
+export * from './posts'