valaxy 0.0.2 → 0.0.7

package/src/types/config.ts

@@ -0,0 +1,250 @@
+import type { PartialDeep } from 'type-fest'
+import type { VitePluginConfig } from 'unocss/vite'
+import type { MarkdownOptions } from '../node/markdown'
+import type { ViteMdOptions } from '../node/plugins/markdown'
+
+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 ValaxyConfig<T = ValaxyThemeConfig> {
+  /**
+   * Default language
+   * @description 默认语言
+   * @default 'en'
+   */
+  lang: string
+  /**
+   * You site url in web, required for ssg, do not add / in end
+   * @description 站点的 URL，SSG 需要（譬如生成版权处文章永久链接），不要在末尾添加 /
+   */
+  url: string
+  /**
+   * Site title
+   * @description 站点标题
+   */
+  title: string
+  /**
+   * 副标题
+   */
+  subtitle: string
+  /**
+   * 站点描述
+   */
+  description: string
+  /**
+   * The owner of this blog
+   * @description 博客作者
+   */
+  author: {
+    /**
+     * Your name
+     * @description 你的名字
+     */
+    name: string
+    avatar: string
+    /**
+     * The status of you
+     * @description 状态
+     */
+    status: {
+      emoji: string
+      /**
+       * show when hover emoji
+       * @description 当鼠标悬浮在图标上时显示
+       */
+      message: string
+    }
+  }
+
+  /**
+   * 社交链接
+   */
+  social: SocialLink[]
+
+  /**
+   * search
+   */
+  search: {
+    algolia: {
+      enable: boolean
+      appId: string
+      apiKey: string
+      indexName: string
+      chunkSize: number
+    }
+  }
+
+  /**
+   * comment: waline/...
+   */
+  comment: {
+    waline: {
+      enable: boolean
+      serverURL: 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 用户配置
+ */
+export type UserConfig<T=ValaxyThemeConfig> = PartialDeep<ValaxyConfig<T>>
+
+export const defaultValaxyConfig: ValaxyConfig = {
+  url: '',
+  lang: 'en',
+  title: 'Valaxy Blog',
+  subtitle: 'Next Generation Static Blog Framework.',
+  author: {
+    avatar: 'https://cdn.jsdelivr.net/gh/YunYouJun/yun/images/meme/yun-good-with-bg.jpg',
+    name: 'YunYouJun',
+    status: {
+      emoji: '😊',
+      message: 'All at sea.',
+    },
+  },
+  social: [],
+  description: 'A blog generated by Valaxy.',
+
+  license: {
+    enabled: true,
+    language: '',
+    type: 'by-nc-sa',
+  },
+
+  sponsor: {
+    enable: true,
+    title: '我很可爱，请给我钱',
+    methods: [
+      {
+        name: '支付宝',
+        url: 'https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/donate/alipay-qrcode.jpg',
+        color: '#00A3EE',
+        icon: 'i-ri-alipay-line',
+      },
+      {
+        name: 'QQ 支付',
+        url: 'https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/donate/qqpay-qrcode.png',
+        color: '#12B7F5',
+        icon: 'i-ri-qq-line',
+      },
+      {
+        name: '微信支付',
+        url: 'https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/donate/wechatpay-qrcode.jpg',
+        color: '#2DC100',
+        icon: 'i-ri-wechat-pay-line',
+      },
+
+    ],
+  },
+
+  search: {
+    algolia: {
+      enable: false,
+      appId: '',
+      apiKey: '',
+      indexName: '',
+      chunkSize: 5000,
+    },
+  },
+
+  comment: {
+    waline: {
+      enable: false,
+      serverURL: '',
+    },
+  },
+
+  theme: 'yun',
+  themeConfig: {},
+
+  unocss: {},
+
+  markdown: {
+    excerpt: '<!-- more -->',
+  },
+  markdownIt: {
+    toc: {
+      listType: 'ol',
+    },
+    katex: {},
+  },
+}

package/src/types/index.ts

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

package/src/types/posts.ts

@@ -0,0 +1,107 @@
+export interface Post {
+  /**
+   * 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
+
+  /**
+   * 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
+}

package/tsup.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig((options) => {
+  return {
+    entry: ['src/node/index.ts', 'src/node/cli.ts', 'src/types/index.ts'],
+    splitting: true,
+    clean: true,
+    dts: true,
+    format: ['cjs', 'esm'],
+    minify: !options.watch,
+    external: [
+      'vite',
+      'sass',
+      'chalk',
+    ],
+  }
+})