valaxy 0.18.9 → 0.18.10

package/types/frontmatter/page.ts

@@ -0,0 +1,191 @@
+import type { ImageObject, NodeRelations } from '@unhead/schema-org'
+
+export 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
+}
+
+export interface Photo {
+  src: string
+  caption: string
+  desc: string
+}
+
+export interface PageFrontMatter 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
+  /**
+   * i18n
+   */
+  lang: string
+
+  /**
+   * @description Author
+   * @description:zh-CN 作者
+   */
+  author: string
+
+  /**
+   * Display sponsor info
+   * @description 是否开启赞助
+   */
+  sponsor: boolean
+  /**
+   * Copyright
+   * @description 是否显示文章底部版权信息
+   */
+  copyright: boolean
+
+  // schema
+  image: NodeRelations<ImageObject | string>
+
+  /**
+   * cover
+   * @description 封面图片
+   */
+  cover: string
+  /**
+   * display toc
+   * @description 是否显示目录
+   */
+  toc: boolean
+  /**
+   * display right sidebar
+   * @description 是否显示右侧侧边栏
+   */
+  aside: 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
+
+  // third-party features
+  /**
+   * use aplayer
+   * @url https://aplayer.js.org/
+   */
+  aplayer: 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[]
+
+  /**
+   * @description:zh-CN 是否启用加密，password 存在时默认为 true
+   */
+  encrypt: boolean
+  /**
+   * @description:zh-CN 加密密码
+   */
+  password?: 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[]
+}

package/types/frontmatter/post.ts

@@ -0,0 +1,103 @@
+import type { PageFrontMatter } from './page'
+
+export type ExcerptType = 'md' | 'html' | 'text' | 'ai'
+
+export 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
+}

package/types/index.ts

@@ -2,6 +2,7 @@
 export * from './addon'
 export * from './config'
 export * from './data'
+export * from './frontmatter'
 export * from './posts'
 
 // used in node, but without node deps

package/types/posts.ts

@@ -1,256 +1,4 @@
-import type { ImageObject, NodeRelations } from '@unhead/schema-org'
-
-export 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
-}
-
-export interface Photo {
-  src: string
-  caption: string
-  desc: string
-}
-
-export type ExcerptType = 'md' | 'html' | 'text' | 'ai'
-
-export interface PageFrontMatter 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
-  /**
-   * i18n
-   */
-  lang: string
-  /**
-   * TODO
-   * Read Time
-   * @description 阅读时长
-   */
-  duration: string
-
-  /**
-   * @description Author
-   * @description:zh-CN 作者
-   */
-  author: string
-
-  /**
-   * Display sponsor info
-   * @description 是否开启赞助
-   */
-  sponsor: boolean
-  /**
-   * Copyright
-   * @description 是否显示文章底部版权信息
-   */
-  copyright: boolean
-
-  // schema
-  image: NodeRelations<ImageObject | string>
-
-  /**
-   * cover
-   * @description 封面图片
-   */
-  cover: string
-  /**
-   * display toc
-   * @description 是否显示目录
-   */
-  toc: boolean
-  /**
-   * display right sidebar
-   * @description 是否显示右侧侧边栏
-   */
-  aside: boolean
-
-  /**
-   * enable markdown-body class
-   * @description 是否启用默认的 markdown 样式
-   */
-  markdown: boolean
-
-  /**
-   * icon before title
-   */
-  icon: string
-  /**
-   * title color
-   */
-  color: string
-  /**
-   * display comment
-   */
-  comment: boolean
-  /**
-   * post is end
-   * @description 是否完结，将在末尾添加衬线字体 Q.E.D.
-   */
-  end: boolean
-
-  // third-party features
-  /**
-   * use aplayer
-   */
-  aplayer: boolean
-  /**
-   * use katex
-   */
-  katex: boolean
-  /**
-   * use codepen
-   */
-  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[]
-
-  /**
-   * @description:zh-CN 是否启用加密，password 存在时默认为 true
-   */
-  encrypt: boolean
-  /**
-   * @description:zh-CN 加密密码
-   */
-  password?: string
-  /**
-   * @description:zh-CN 相册密码
-   */
-  gallery_password?: string
-  /**
-   * @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[]
-}
-
-export interface PostFrontMatter extends PageFrontMatter {
-  /**
-   * post card type, can be bilibili/yuque/...
-   */
-  type: string
-  /**
-   * override url, and jump directly
-   */
-  url: string
-  /**
-   * @description 摘要
-   */
-  excerpt: string
-  /**
-   * @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'
-
-  /**
-   * Category
-   * @description 分类，若为数组，则按顺序代表多层文件夹
-   */
-  categories: string | string[]
-  /**
-   * Tags
-   * @description 标签，可以有多个
-   */
-  tags: string[]
-
-  /**
-   * display prev next
-   * @description 是否显示前一篇、后一篇导航
-   */
-  nav: boolean
-
-  /**
-   * 置顶
-   */
-  top: number
-
-  /**
-   * is draft
-   * @description 是否为草稿
-   */
-  draft: boolean
-  /**
-   * hide in index
-   * - true/`all`: hide in index & archive
-   * - `index`: hide in index
-   * @description 是否隐藏
-   */
-  hide: 'index' | boolean
-
-  /**
-   * 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
-}
+import type { PageFrontMatter, PostFrontMatter } from './frontmatter'
 
 export type Page = Partial<PageFrontMatter>
 export type Post = Partial<PostFrontMatter>