Valaxy API Docs

Appearance

Interface: SiteConfig ​

Properties ​

author ​

author: object

The owner of this blog

avatar ​

avatar: string

email ​

email: string

link: string

name ​

name: string

Your name

Description ​

你的名字

status ​

status: object

The status of you

Description ​

状态

status.emoji ​

emoji: string

Emoji representation of your status like '👨‍💻'

Description ​

你的状态的 Emoji 表示，如 '👨‍💻'

status.message ​

message: string

show when hover emoji

Description ​

当鼠标悬浮在图标上时显示

Description ​

博客作者

Defined in ​

packages/valaxy/types/config.ts:95

cdn ​

cdn: object

third-party plugin need cdn aplayer, twikoo

prefix ​

prefix: string

Default ​

ts
'https://unpkg.com/'

Defined in ​

packages/valaxy/types/config.ts:203

codeHeightLimit? ​

optional codeHeightLimit: number

@description:en-US Limit the height of the code block in px @description:zh-CN 限制代码块的高度，单位是 px

Defined in ​

packages/valaxy/types/config.ts:351

comment ​

comment: object

comment: waline/...

enable ​

enable: boolean

Defined in ​

packages/valaxy/types/config.ts:194

description ​

description: string

站点描述

Defined in ​

packages/valaxy/types/config.ts:90

encrypt ​

encrypt: object

algorithm ​

algorithm: string

encrypt

Default ​
ts
AES-CBC

enable ​

enable: boolean

iv ​

iv: Uint8Array

salt ​

salt: Uint8Array

Description ​

Encrypt article @description:zh-CN 加密文章 default algorithm: AES-CBC

Defined in ​

packages/valaxy/types/config.ts:332

favicon ​

favicon: string

icon for your website

Defined in ​

packages/valaxy/types/config.ts:130

feed ​

feed: object

favicon ​

favicon: string

name ​

name: string

name: feed -> feed.xml / feed.atom / feed.json

Default ​
ts
'' -> feed.xml / atom.xml / feed.json

Defined in ​

packages/valaxy/types/config.ts:132

floatingVue ​

floatingVue: any

Floating Vue configuration for floating footnote tooltips.

See ​

https://floating-vue.starpad.dev/guide/config

Defined in ​

packages/valaxy/types/config.ts:295

frontmatter ​

frontmatter: Partial<PostFrontMatter>

set post default frontmatter

Defined in ​

packages/valaxy/types/config.ts:189

fuse ​

fuse: object

fuse search

dataPath ​

dataPath: string

Default ​
ts
'valaxy-fuse-list.json'
Description ​

搜索结果列表数据所在路径

options ​

options: FuseOptions<FuseListItem> & object

Type declaration ​
keys ​

keys: undefined | FuseOptionKey<FuseListItem>[]

Default ​
ts
['title', 'tags', 'categories', 'excerpt']
Description ​

搜索的字段

See ​

https://fusejs.io/api/options.html#keys

See ​

https://fusejs.io/api/options.html

See ​

https://fusejs.io/

Description ​

本地搜索 Please set search.type to 'fuse'

Defined in ​

packages/valaxy/types/config.ts:167

lang ​

lang: string

Default language

Description ​

默认语言，设置 zh-CN 以改变默认语言为中文

Default ​

ts
'en'

Defined in ​

packages/valaxy/types/config.ts:54

languages ​

languages: string[]

alternative languages

Description ​

可选语言

Default ​

ts
['en', 'zh-CN']

See ​

https://ogp.me/#optional

Defined in ​

packages/valaxy/types/config.ts:61

lastUpdated ​

lastUpdated: boolean

show last updated time by git/mtime

Defined in ​

packages/valaxy/types/config.ts:125

license ​

license: object

The license of your posts

enabled ​

enabled: boolean

Whether to show at the bottom of the article

Description ​

是否显示在文章底部

Default ​
ts
true

language ​

language: string

Creative License Language, same with your config.lang when lang === 'zh-CN', use 'zh'

Description ​

默认与站点语言相同

Default ​
ts
'en'

type ​

type: "by-nc-sa" | "zero" | "by-sa" | "by-nd" | "by-nc" | "by-nc-nd"

Type of license

Description ​

证书类型

Default ​
ts
'by-nc-sa'

Description ​

文章所使用的协议，默认使用 Creative Commons

Default ​

ts
https://creativecommons.org/licenses/

Defined in ​

packages/valaxy/types/config.ts:212

mediumZoom ​

mediumZoom: object

image preview by medium-zoom

enable ​

enable: boolean

Zh ​

启用图片预览

options ​

options: ZoomOptions

Zh ​

配置项

See ​

https://github.com/francoischalifour/medium-zoom#options

selector ​

selector: string | HTMLElement | HTMLElement[]

For example: '.markdown-body img'

Default ​
ts
'' content.value querySelectorAll('img')

Url ​

https://github.com/francoischalifour/medium-zoom

Defined in ​

packages/valaxy/types/config.ts:264

mode ​

mode: "auto" | "light" | "dark"

enable auto (light/dark mode)

Default ​

ts
'auto'

Defined in ​

packages/valaxy/types/config.ts:48

pageSize ​

pageSize: number

displayed posts length in every page

Default ​

ts
7

Defined in ​

packages/valaxy/types/config.ts:301

redirects? ​

optional redirects: object

@description:en-US client redirect rules @description:zh-CN 客户端重定向规则

rules? ​

optional rules: RedirectRule[]

useVueRouter? ​

optional useVueRouter: boolean

Defined in ​

packages/valaxy/types/config.ts:357

search: object

search

enable ​

enable: boolean

type ​

type: "fuse" | "algolia" | "engine"

Search Type

  • algolia: Algolia Search
  • engine: Engine Search, like Google/Baidu
  • fuse: Local Search by fuse.js

Defined in ​

packages/valaxy/types/config.ts:149

social ​

social: SocialLink[]

社交链接

Defined in ​

packages/valaxy/types/config.ts:144

sponsor: object

donate for author

description? ​

optional description: string

Donate content description

Description ​

打赏的描述内容，在按钮下方所有图片上方，与图片一起折叠

Default ​
ts
undefined 不显示内容

enable ​

enable: boolean

methods ​

methods: object[]

title? ​

optional title: string

Donate button title attribute

Description ​

打赏按钮的 title 属性

Default ​
ts
zh:'打赏' en:'Donate'

Description ​

打赏/赞助

Defined in ​

packages/valaxy/types/config.ts:238

statistics ​

statistics: object

statistics readingTime and wordCount

enable ​

enable: boolean

readTime ​

readTime: object

readTime.speed ​

speed: object

readTime.speed.cn ​

cn: number

Chinese word count speed

Description ​

中文每分钟阅读字数

Default ​
ts
300 (300 字/分钟)

readTime.speed.en ​

en: number

English word count speed

Description ​

英文每分钟阅读字数

Default ​
ts
100 (200 字/分钟)

Description ​

统计阅读时间和字数

Defined in ​

packages/valaxy/types/config.ts:307

subtitle ​

subtitle: string

副标题

Defined in ​

packages/valaxy/types/config.ts:86

timezone ​

timezone: string

See ​

https://wikipedia.org/wiki/List_of_tz_database_time_zones @en_US Timezone configuration @zh_CN 时区配置，国内推荐使用 'Asia/Shanghai' @description:en-US This configuration is used to generate times with timezone when no timezone is set @description:zh-CN 当时间没有设置时区时，使用该配置生成带时区的时间

Default ​

ts
''

Defined in ​

packages/valaxy/types/config.ts:76

title ​

title: string

Site title

Description ​

站点标题

Defined in ​

packages/valaxy/types/config.ts:82

url ​

url: string

Defined in ​

packages/valaxy/types/config.ts:77

vanillaLazyload ​

vanillaLazyload: object

lazyload by vanilla-lazyload and markdown-it-image-figures when vanillaLazyLoad.enable is true, imageFigures removeSrc is true, classes is 'lazy'

enable ​

enable: boolean

options ​

options: ILazyLoadOptions

See ​

https://github.com/verlok/vanilla-lazyload

Defined in ​

packages/valaxy/types/config.ts:286