valaxy 0.7.7 → 0.8.1

package/types/posts.ts

@@ -0,0 +1,133 @@
+export 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
+}

package/client/components/ValaxyRightSidebar.vue

@@ -1,73 +0,0 @@
-<script lang="ts" setup>
-import { useI18n } from 'vue-i18n'
-import type { Post } from '../../types'
-import { useAppStore } from '~/stores/app'
-defineProps<{ frontmatter: Post }>()
-const { t } = useI18n()
-
-const app = useAppStore()
-</script>
-
-<template>
-  <button
-    class="xl:hidden toc-btn shadow fixed yun-icon-btn z-350"
-    opacity="75" right="2" bottom="19"
-    @click="app.toggleRightSidebar()"
-  >
-    <div i-ri-file-list-line />
-  </button>
-
-  <ValaxyOverlay :show="app.isRightSidebarOpen" @click="app.toggleRightSidebar()" />
-
-  <aside class="right-sidebar fixed va-card" :class="app.isRightSidebarOpen && 'open'" m="l-4" text="center">
-    <h2 v-if="frontmatter.toc !== false" m="t-6 b-2" font="serif black">
-      {{ t('sidebar.toc') }}
-    </h2>
-
-    <div class="right-sidebar-container">
-      <ValaxyToc v-if="frontmatter.toc !== false" />
-
-      <div v-if="$slots.custom" class="custom-container">
-        <slot name="custom" />
-      </div>
-    </div>
-  </aside>
-</template>
-
-<style lang="scss">
-@use '~/styles/mixins' as *;
-
-@include xl {
-  .right-sidebar {
-    transform: translateX(0) !important;
-  }
-}
-
-.right-sidebar {
-  width: var(--va-sidebar-width-mobile);
-
-  position: fixed;
-  top: 0;
-  bottom: 0;
-  right: 0;
-
-  transform: translateX(100%);
-
-  transition: box-shadow var(--va-transition-duration),
-  background-color var(--va-transition-duration), opacity 0.25s,
-  transform var(--va-transition-duration) cubic-bezier(0.19, 1, 0.22, 1);
-
-  &.open {
-    z-index: 10;
-    transform: translateX(0);
-  }
-}
-.right-sidebar-container {
-  top: 1rem;
-}
-
-.toc-btn {
-  color: var(--va-c-primary);
-  background-color: white;
-}
-</style>

package/client/components/ValaxyToc.vue

@@ -1,140 +0,0 @@
-<script lang="ts" setup>
-// this is a runtime toc
-// prebuild toc see composables/outline.ts
-import { onMounted, ref, watch } from 'vue'
-import { useI18n } from 'vue-i18n'
-import { useRoute } from 'vue-router'
-
-import type { Header } from '../../types'
-import { useActiveSidebarLinks } from '~/composables'
-import { useConfig } from '~/config'
-
-const container = ref()
-const marker = ref()
-useActiveSidebarLinks(container, marker)
-
-function getStylesByLevel(level: number) {
-  return {
-    // fontSize: `${(6 - level) * 0.1 + 0.7}rem`,
-    paddingLeft: `${level * 1 - 1}rem`,
-  }
-}
-
-const { locale } = useI18n()
-
-const config = useConfig()
-
-function useHeaders() {
-  const headers = ref<Header[]>([])
-  const route = useRoute()
-
-  function generateHeaders() {
-    headers.value = []
-
-    const content = document.querySelector('.markdown-body')
-    const levels = config.value.markdownIt.toc!.includeLevel!.map(level => `h${level}`)
-
-    content?.querySelectorAll(levels as any).forEach((header) => {
-      headers.value.push({
-        level: header.tagName.toLowerCase().replace('h', ''),
-        title: header.textContent.replace('#', ''),
-        slug: header.id,
-        lang: header.lang || locale.value,
-      })
-    })
-  }
-
-  watch(() => route.path, () => {
-    generateHeaders()
-  })
-
-  onMounted(() => {
-    generateHeaders()
-  })
-
-  return {
-    headers,
-    generateHeaders,
-  }
-}
-
-const { headers, generateHeaders } = useHeaders()
-
-if (import.meta.hot) {
-  import.meta.hot.on('valaxy:md-update', () => {
-    setTimeout(() => {
-      generateHeaders()
-      // 400ms transition
-    }, 600)
-  })
-}
-</script>
-
-<template>
-  <div v-if="headers" ref="container">
-    <div ref="marker" class="outline-marker" />
-    <ul class="va-toc" p="l-4">
-      <li v-for="header, i in headers" :key="i" :lang="header.lang || locale" class="va-toc-item" :style="getStylesByLevel(header.level)">
-        <a class="toc-link-item" :href="`#${header.slug}`">{{ header.title }}</a>
-      </li>
-    </ul>
-  </div>
-</template>
-
-<style lang="scss">
-.outline-marker {
-  opacity: 0;
-  position: absolute;
-  background-color: var(--va-c-primary);
-  border-radius: 4px;
-  width: 4px;
-  height: 20px;
-  top: 32px;
-  left: 20px;
-  z-index: 0;
-  transition: top 0.25s cubic-bezier(0, 1, 0.5, 1), opacity 0.25s,
-    background-color 0.5s;
-}
-
-.va-toc {
-  top: 10px;
-  width: var(--yun-sidebar-width-mobile);
-
-  background-color: var(--va-c-bg-light);
-
-  font-size: 1rem;
-  font-family: var(--va-font-serif);
-  font-weight: 900;
-  line-height: 1.6;
-
-  text-align: left;
-
-  a {
-    display: block;
-    color: var(--c-toc-link);
-    transition: color var(--va-transition-duration);
-
-    overflow: hidden;
-    white-space: nowrap;
-    text-overflow: ellipsis;
-
-    font-weight: 900;
-
-    &:hover {
-      color: var(--va-c-text);
-    }
-  }
-
-  .toc-link-item {
-    color: var(--va-c-text-light);
-
-    &:hover {
-      color: var(--va-c-text);
-    }
-
-    &.active {
-      color: var(--va-c-primary);
-    }
-  }
-}
-</style>

package/client/modules/README.md

@@ -1,11 +0,0 @@
-## Modules
-
-A custom user module system. Place a `.ts` file with the following template, it will be installed automatically.
-
-```ts
-import type { UserModule } from '~/types'
-
-export const install: UserModule = ({ app, router, isClient }) => {
-  // do something
-}
-```

package/client/pages/README.md

@@ -1,20 +0,0 @@
-# File-based Routing
-
-Routes will be auto-generated for Vue files in this dir with the same file structure.
-Check out [`vite-plugin-pages`](https://github.com/hannoeru/vite-plugin-pages) for more details.
-
-## Path Aliasing
-
-`~/` is aliased to `./src/` folder.
-
-For example, instead of having
-
-```ts
-import { isDark } from '../../../../composables'
-```
-
-now, you can use
-
-```ts
-import { isDark } from '~/composables'
-```

package/client/shims.d.ts

@@ -1,42 +0,0 @@
-import 'vue-router'
-
-import type { Post } from 'valaxy'
-import type { Header } from '../node/markdown'
-
-// markdowns can be treat as Vue components
-declare module '*.md' {
-  import type { DefineComponent } from 'vue'
-  const component: DefineComponent<{}, {}, any>
-  export default component
-}
-
-declare module '*.vue' {
-  import type { DefineComponent } from 'vue'
-  const component: DefineComponent<{}, {}, any>
-  export default component
-}
-
-// vite hmr data
-declare module '/@valaxyjs/config' {
-  // import type { ValaxyConfig } from 'valaxy'
-  const config: string
-  export default config
-}
-
-declare module '/@valaxyjs/context' {
-  const ctx: string
-  export default ctx
-}
-
-declare module '/@valaxyjs/locales' {
-  const messages: {}
-  export default messages
-}
-
-declare module 'vue-router' {
-  interface RouteMeta {
-    headers: Header[]
-    frontmatter: Post
-  }
-}
-