valaxy 0.19.1 → 0.19.2

package/client/App.vue

@@ -93,5 +93,9 @@ useSchemaOrg([
   <ValaxyThemeApp />
   <ValaxyAddons />
   <ValaxyUserApp />
-  <RouterView />
+  <router-view v-slot="{ Component, route }">
+    <transition name="app-transition">
+      <component :is="Component" :key="route" />
+    </transition>
+  </router-view>
 </template>

package/client/composables/categories.ts

@@ -13,6 +13,13 @@ export interface BaseCategory {
   total: number
 }
 
+/**
+ * @en
+ * Category list
+ *
+ * @zh
+ * 分类列表
+ */
 export interface CategoryList {
   /**
    * category name
@@ -27,7 +34,11 @@ export interface CategoryList {
 export type Category = CategoryList
 export type Categories = Map<string, Post | CategoryList>
 
-// todo write unit test
+/**
+ * For theme development, you can use this function to determine whether the category is a category list.
+ * @todo write unit test
+ * @param category
+ */
 export function isCategoryList(category: any): category is CategoryList {
   return category.children
 }

package/client/composables/outline/headers.ts

@@ -3,6 +3,13 @@ import type { DefaultTheme, Header } from 'valaxy/types'
 import { onContentUpdated } from '../../utils'
 import { useFrontmatter, useThemeConfig } from '../..'
 
+/**
+ * @en
+ * Menu item, the title menu parsed from the article.
+ *
+ * @zh
+ * 菜单项，从文章中解析出的标题菜单。
+ */
 export type MenuItem = Omit<Header, 'slug' | 'children'> & {
   children?: MenuItem[]
 }
@@ -105,7 +112,11 @@ export function useOutline() {
  * get headers from document directly
  */
 export function getHeaders(range: Exclude<DefaultTheme.Config['outline'], false>) {
-  const headers = Array.from(document.querySelectorAll('.markdown-body :where(h1,h2,h3,h4,h5,h6)'))
+  // when transition, the markdown-body will be two
+  // the first is the old one, the last is the new one
+  const markdownBodyElements = document.querySelectorAll('.markdown-body') as NodeListOf<HTMLElement>
+  const markdownBody = markdownBodyElements[markdownBodyElements.length - 1]
+  const headers = Array.from(markdownBody.querySelectorAll('.markdown-body :where(h1,h2,h3,h4,h5,h6)'))
     .filter(el => el.id && el.hasChildNodes())
     .map((el) => {
       const level = Number(el.tagName[1])

package/client/composables/tags.ts

@@ -2,6 +2,15 @@ import { computed } from 'vue'
 import type { Post } from '../../types'
 import { useSiteStore } from '../stores'
 
+/**
+ * @en
+ * Tag list, key is tag name, value is the object of tag.
+ * - count: the number of posts with this tag.
+ *
+ * @zh
+ * 标签列表，键是标签名，值是标签对象。
+ * - count: 使用该标签的文章数量。
+ */
 export type Tags = Map<string, {
   count: number
 }>

package/client/locales/en.yml

@@ -35,8 +35,8 @@ sidebar:
 
 post:
   decrypt: DECRYPT
-  posted: Posted on
-  edited: Edited on
+  posted: 'Posted on '
+  edited: 'Edited on '
   created: Created
   modified: Modified
   edit: Edit this post

package/client/setup/mermaid.ts

@@ -3,6 +3,13 @@
 import { defineMermaidSetup } from 'valaxy'
 import type { MermaidOptions } from '../types'
 
+/**
+ * @en
+ * Extend the Mermaid configuration.
+ *
+ * @zh
+ * 扩展 Mermaid 配置。
+ */
 export default defineMermaidSetup(() => {
   // eslint-disable-next-line prefer-const
   let injection_return: MermaidOptions = {

package/client/setups.ts

@@ -2,6 +2,14 @@ import type { ViteSSGContext } from 'vite-ssg'
 import type { Awaitable } from '@antfu/utils'
 import type { MermaidOptions } from './types'
 
+/**
+ * @see https://github.com/antfu-collective/vite-ssg
+ * @en
+ * The context object for the application setup function.
+ *
+ * @zh
+ * 应用 setup 函数的上下文对象。（包括了 ViteSSG context）
+ */
 export type AppContext = ViteSSGContext
 
 export type AppSetup = (ctx: AppContext) => Awaitable<void>
@@ -9,6 +17,13 @@ export type AppSetup = (ctx: AppContext) => Awaitable<void>
 // client
 export type MermaidSetup = () => Partial<MermaidOptions> | void
 
+/**
+ * @en
+ * Define the setup function for the client application.
+ *
+ * @zh
+ * 扩展客户端应用的 setup 函数。
+ */
 export function defineAppSetup(fn: AppSetup) {
   return fn
 }

package/client/types/index.ts

@@ -3,4 +3,7 @@ import type mermaid from 'mermaid'
 
 export type UserModule = (ctx: ViteSSGContext) => void
 
+/**
+ * @see https://mermaid.js.org/config/schema-docs/config.html#mermaid-config-schema
+ */
 export type MermaidOptions = (typeof mermaid.initialize) extends (a: infer A) => any ? A : never

package/client/utils/router.ts

@@ -1,7 +1,18 @@
 import type { Router } from 'vue-router'
 
+/**
+ * @en
+ * Options for scrolling to a target element.
+ *
+ * @zh
+ * 滚动到目标元素的选项。
+ */
 export interface ScrollToOptions {
   /**
+   * @en
+   * Whether to scroll smoothly.
+   *
+   * @zh
    * 平滑滚动
    */
   smooth: boolean
@@ -11,6 +22,13 @@ export interface ScrollToOptions {
   targetPadding: number
 }
 
+/**
+ * For theme developers, you can use this function to scroll to the target element.
+ * For example, when you click the anchor link in the markdown file, it will scroll to the target element.
+ * @param el
+ * @param hash
+ * @param options
+ */
 export function scrollTo(el: HTMLElement, hash: string, options: Partial<ScrollToOptions> = {
   smooth: true,
   targetPadding: -64,

package/client/utils/time.ts

@@ -10,6 +10,14 @@ export function formatDate(date: string | number | Date, template = 'yyyy-MM-dd'
   return format(date, template)
 }
 
+/**
+ * date-fns format date with 'yyyy-MM-dd HH:mm:ss'
+ * @param date
+ */
+export function formatTimestamp(date: string | number | Date): string {
+  return format(date, 'yyyy-MM-dd HH:mm:ss')
+}
+
 /**
  * sort posts by date
  * @param posts