valaxy 0.7.8 → 0.9.0

package/README.md

@@ -4,6 +4,10 @@
 
 Read [YunYouJun/valaxy](https://github.com/YunYouJun/valaxy) for more info.
 
+## Creating customized templates
+
+Learn how to creating customized templates in [here](./docs/en/creating-templates.md)
+
 ## FAQ
 
 - `exports`: `src/index.ts` for virtual module

package/client/README.md

@@ -0,0 +1,3 @@
+# FAQ
+
+- use relative path in `valaxy/client` to avoid client/node problem

package/client/components/ValaxyCopyright.vue

@@ -51,7 +51,7 @@ const licenseHtml = computed(() => {
 </template>
 
 <style lang="scss">
-@use "~/styles/mixins" as *;
+@use "valaxy/client/styles/mixins/index.scss" as *;
 
 .post-copyright {
   font-size: 0.9rem;

package/client/components/ValaxyMd.vue

@@ -1,10 +1,8 @@
 <script lang="ts" setup>
-import type { Post } from 'valaxy'
 import { onMounted, ref } from 'vue'
 import { useI18n } from 'vue-i18n'
-import { useAplayer, useCodePen } from '~/composables'
-import { useCopyCode } from '~/composables/copy-code'
-import { wrapTable } from '~/utils'
+import { useAplayer, useCodePen, useCopyCode, wrapTable } from '..'
+import type { Post } from '../../types'
 
 const props = defineProps<{
   frontmatter: Post

package/client/components/ValaxyOverlay.vue

@@ -15,8 +15,8 @@ withDefaults(defineProps<{
 <style lang="scss">
 @use "sass:map";
 
-@use "~/styles/vars" as *;
-@use "~/styles/mixins" as *;
+@use "valaxy/client/styles/vars" as *;
+@use "valaxy/client/styles/mixins" as *;
 
 .va-overlay {
   background-color: rgba(0, 0, 0, 0.3);

package/client/components/ValaxySidebar.vue

@@ -1,6 +1,5 @@
 <script lang="ts" setup>
-import { useLayout } from '~/composables'
-import { useAppStore } from '~/stores/app'
+import { useAppStore, useLayout } from '..'
 
 const app = useAppStore()
 const isHome = useLayout('home')

package/client/composables/category.ts

@@ -1,5 +1,5 @@
 import { unref } from 'vue'
-import type { Post } from 'valaxy/types'
+import type { Post } from '../../types'
 import { usePostList } from './post'
 
 export interface BaseCategory {

package/client/composables/comments/index.ts

@@ -1,2 +1,3 @@
 export * from './twikoo'
-export * from './waline'
+// import on demand
+// export * from './waline'

package/client/composables/comments/twikoo.ts

@@ -1,8 +1,8 @@
 import { isClient, useScriptTag } from '@vueuse/core'
-import { useConfig } from 'valaxy'
 import { computed } from 'vue'
 import { useI18n } from 'vue-i18n'
 import { useRoute } from 'vue-router'
+import { useConfig } from '../..'
 
 declare global {
   interface Window {

package/client/composables/comments/waline.ts

@@ -4,8 +4,6 @@ import { useI18n } from 'vue-i18n'
 import { useRoute } from 'vue-router'
 
 import type { WalineInitOptions, WalineInstance } from '@waline/client'
-
-import '@waline/client/dist/waline.css'
 import { cdnPrefix } from '../../utils'
 
 /**
@@ -20,6 +18,9 @@ export function useWaline(options: {} = {}, cdn = cdnPrefix) {
   if (!isClient)
     return
 
+  // import css
+  import('@waline/client/dist/waline.css')
+
   const route = useRoute()
 
   const { locale } = useI18n()

package/client/composables/common.ts

@@ -2,7 +2,7 @@ import { useRoute } from 'vue-router'
 import { computed } from 'vue'
 import { isClient } from '@vueuse/core'
 
-import type { Post } from 'valaxy/types'
+import type { Post } from '../../types'
 import { useConfig } from '../config'
 
 export function useFrontmatter() {

package/client/composables/features/index.ts

@@ -0,0 +1 @@
+export * from './copy-code'

package/client/composables/index.ts

@@ -5,7 +5,7 @@ export * from './tag'
 
 // common
 export * from './common'
-// export * from './features'
+export * from './features'
 export * from './helper'
 export * from './dark'
 export * from './layout'
@@ -13,6 +13,7 @@ export * from './widgets'
 export * from './locale'
 
 export * from './sidebar'
+export * from './outline'
 
 // comment
 export * from './comments'

package/client/composables/outline.ts

@@ -1,7 +1,7 @@
 import type { Ref } from 'vue'
 import { onMounted, onUnmounted, onUpdated } from 'vue'
-import type { Header } from 'valaxy/types'
-import { throttleAndDebounce } from '~/utils'
+import { throttleAndDebounce } from '../utils'
+import type { Header } from '../../types'
 
 interface HeaderWithChildren extends Header {
   children?: Header[]

package/client/composables/post.ts

@@ -2,7 +2,7 @@ import type { Ref } from 'vue'
 import { computed } from 'vue'
 import { useRoute, useRouter } from 'vue-router'
 import { useI18n } from 'vue-i18n'
-import type { Post } from 'valaxy/types'
+import type { Post } from '../../types'
 import { sortByDate } from '../utils'
 
 export const usePostTitle = (post: Ref<Post>) => {

package/client/composables/tag.ts

@@ -1,5 +1,5 @@
 import { TinyColor } from '@ctrl/tinycolor'
-import type { Post } from 'valaxy/types'
+import type { Post } from '../../types'
 import { usePostList } from './post'
 
 export type Tags = Map<string, {

package/client/composables/widgets/aplayer.ts

@@ -1,7 +1,7 @@
 import { useScriptTag } from '@vueuse/core'
 import { useHead } from '@vueuse/head'
-import { useConfig } from 'valaxy'
 import { computed } from 'vue'
+import { useConfig } from '../..'
 
 /**
  * use MetingJS and Aplayer

package/client/config.ts

@@ -5,6 +5,9 @@ import valaxyContext from '/@valaxyjs/context'
 import type { ComputedRef, InjectionKey, Ref } from 'vue'
 import { computed, inject, readonly, shallowRef } from 'vue'
 // import type { RouteMeta } from 'vue-router'
+// fix build caused by pnpm
+// This is likely not portable. A type annotation is necessary.
+// https://github.com/microsoft/TypeScript/issues/42873
 import type { PageData, ValaxyConfig } from 'valaxy/types'
 
 /**
@@ -60,6 +63,17 @@ export function useConfig<ThemeConfig = any>() {
   return config!
 }
 
+/**
+ * You can use like this: import { useThemeConfig } from 'valaxy-theme-xxx'
+ * if you want to: import { useThemeConfig } from 'valaxy'
+ * you need pass themeConfig by yourself
+ * @returns
+ */
+export function useThemeConfig<T = Record<string, any>>() {
+  const config = useConfig<T>()
+  return computed(() => config!.value.themeConfig)
+}
+
 export interface ValaxyData<T = any> {
   page: Ref<PageData>
   theme: Ref<T>

package/client/index.ts

@@ -6,3 +6,5 @@ export * from './stores/app'
 export * from './utils'
 
 export * from './setups'
+
+export * from './types'

package/client/modules/nprogress.ts

@@ -1,5 +1,5 @@
 import NProgress from 'nprogress'
-import type { UserModule } from '~/types'
+import type { UserModule } from '../types'
 
 export const install: UserModule = ({ isClient, router }) => {
   if (isClient) {

package/client/modules/pinia.ts

@@ -1,5 +1,5 @@
 import { createPinia } from 'pinia'
-import type { UserModule } from '~/types'
+import type { UserModule } from '../types'
 
 // Setup Pinia
 // https://pinia.esm.dev/

package/client/modules/valaxy.ts

@@ -11,11 +11,11 @@ import { createI18n } from 'vue-i18n'
 import { useStorage } from '@vueuse/core'
 
 import type { Router } from 'vue-router'
-import type { PageDataPayload } from 'valaxy/types'
+import type { PageDataPayload } from '../../types'
 import { initConfig, valaxyConfigSymbol } from '../config'
 import { ensureSuffix } from '@antfu/utils'
 
-import type { UserModule } from '~/types'
+import type { UserModule } from 'valaxy/client/types'
 
 // @ts-expect-error virtual
 import messages from '/@valaxyjs/locales'

package/client/scaffolds/post.md

@@ -0,0 +1,6 @@
+---
+layout: <%=layout%>
+title: <%=title%>
+date: <%=date%>
+---
+

package/client/styles/common/code.scss

@@ -1,4 +1,4 @@
-@use "~/styles/mixins" as *;
+@use "valaxy/client/styles/mixins" as *;
 
 @include mobile {
   .markdown-body {

package/client/styles/common/scrollbar.scss

@@ -1,4 +1,4 @@
-@use "~/styles/mixins" as *;
+@use "valaxy/client/styles/mixins" as *;
 
 ::-webkit-scrollbar {
   width: 8px;

package/client/utils/time.ts

@@ -1,5 +1,5 @@
 import dayjs from 'dayjs'
-import type { Post } from 'valaxy/types'
+import type { Post } from '../../types'
 
 /**
  * use dayjs format date