Valaxy API Docs

Appearance

Interface: SiteConfig ​

Defined in: packages/valaxy/types/config.ts:44

Properties ​

author ​

ts
author: object;

Defined in: packages/valaxy/types/config.ts:98

The owner of this blog

avatar ​

ts
avatar: string;

email ​

ts
email: string;

intro? ​

ts
optional intro: string;
Zh ​

个人简介

ts
link: string;

name ​

ts
name: string;

Your name

Description ​

你的名字

status ​

ts
status: object;

The status of you

Description ​

状态

status.emoji ​
ts
emoji: string;

Emoji representation of your status like '👨‍💻'

Description ​

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

status.message ​
ts
message: string;

show when hover emoji

Description ​

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

Description ​

博客作者

cdn ​

ts
cdn: object;

Defined in: packages/valaxy/types/config.ts:272

third-party plugin need cdn aplayer, twikoo

prefix ​

ts
prefix: string;

prefix for your third-party

Default ​
ts
'https://unpkg.com/'

Default ​

ts
'https://unpkg.com/'

codeHeightLimit? ​

ts
optional codeHeightLimit: number;

Defined in: packages/valaxy/types/config.ts:427

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

comment ​

ts
comment: object;

Defined in: packages/valaxy/types/config.ts:263

comment: waline/...

enable ​

ts
enable: boolean;

description ​

ts
description: string;

Defined in: packages/valaxy/types/config.ts:93

站点描述

encrypt ​

ts
encrypt: object;

Defined in: packages/valaxy/types/config.ts:408

algorithm ​

ts
algorithm: string;

encrypt

Default ​
ts
AES-CBC

enable ​

ts
enable: boolean;

iv ​

ts
iv: Uint8Array;

salt ​

ts
salt: Uint8Array;

Description ​

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

excerpt ​

ts
excerpt: object;

Defined in: packages/valaxy/types/config.ts:231

Excerpt configuration @description:en-US Global excerpt settings for posts @description:zh-CN 全局摘要配置

auto ​

ts
auto: boolean;

@description:en-US Auto-generate excerpt from post content when no manual excerpt is provided @description:zh-CN 当没有手动指定摘要时，自动从文章内容截取摘要

Default ​
ts
false

length ​

ts
length: number;

@description:en-US Maximum length of auto-generated excerpt (in characters) @description:zh-CN 自动摘要的最大长度（字符数）

Default ​
ts
200

type ​

ts
type: ExcerptType;

@description:en-US Default excerpt render type for <!-- more --> and auto-generated excerpts. Can be overridden per-post via frontmatter excerpt_type. Does not apply when frontmatter excerpt is set manually (used as-is). @description:zh-CN <!-- more --> 及自动摘要的默认渲染类型，可通过 frontmatter excerpt_type 逐篇覆盖。 当 frontmatter 手动指定 excerpt 时不生效（直接使用原始字符串）。

Default ​
ts
'html'

favicon ​

ts
favicon: string;

Defined in: packages/valaxy/types/config.ts:150

icon for your website

feed ​

ts
feed: object;

Defined in: packages/valaxy/types/config.ts:152

favicon ​

ts
favicon: string;

name ​

ts
name: string;

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

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

floatingVue ​

ts
floatingVue: any;

Defined in: packages/valaxy/types/config.ts:371

Floating Vue configuration for floating footnote tooltips.

See ​

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

frontmatter ​

ts
frontmatter: Partial<PostFrontMatter>;

Defined in: packages/valaxy/types/config.ts:258

set post default frontmatter

fuse ​

ts
fuse: object;

Defined in: packages/valaxy/types/config.ts:196

fuse search

dataPath ​

ts
dataPath: string;
Default ​
ts
'valaxy-fuse-list.json'
Description ​

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

options ​

ts
options: FuseOptions<FuseListItem> & object;
Type Declaration ​
keys ​
ts
keys: FuseOptionKey<FuseListItem>[] | undefined;

@en_US The fields to be searched. @zh_CN 搜索的字段

Default ​
ts
['title', 'tags', 'categories', 'excerpt']
@description:en-US List of keys that will be searched. This supports nested paths, weighted search, and searching in arrays of strings and objects
@description:zh-CN 搜索将会涉及的字段列表，支持嵌套路径、加权搜索以及在字符串和对象数组中进行搜索
See ​

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

See ​

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

pattern? ​

ts
optional pattern: string;

fast-glob pattern to match Fuse List Data

Default ​

pages/**/*.md

ts
await fg(`${userRoot}/pages/posts/**/*.md`)

See ​

https://fusejs.io/

Description ​

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

lang ​

ts
lang: string;

Defined in: packages/valaxy/types/config.ts:55

Default language

Description ​

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

Default ​

ts
'en'

languages ​

ts
languages: string[];

Defined in: packages/valaxy/types/config.ts:64

alternative languages

Description ​

可选语言

En ​

If you want to disable multi-language support for your site, you can set this to only include one language (e.g. ['en'])

Zh ​

如果你想要禁言站点的多语言支持，可以将此项设置为仅包含一个语言 (例如 ['zh-CN'])

Default ​

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

See ​

https://ogp.me/#optional

lastUpdated ​

ts
lastUpdated: boolean;

Defined in: packages/valaxy/types/config.ts:145

show last updated time by git/mtime

Default ​

ts
false

license ​

ts
license: object;

Defined in: packages/valaxy/types/config.ts:285

The license of your posts

enabled ​

ts
enabled: boolean;

Whether to show at the bottom of the article

Description ​

是否显示在文章底部

Default ​
ts
true

language ​

ts
language: string;

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

Description ​

默认与站点语言相同

Default ​
ts
'en'

type ​

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

Type of license

Description ​

证书类型

Default ​
ts
'by-nc-sa'

Description ​

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

Default ​

ts
https://creativecommons.org/licenses/

llms ​

ts
llms: object;

Defined in: packages/valaxy/types/config.ts:434

enable ​

ts
enable: boolean;
Zh ​

是否开启 llms.txt 和 .md 原始文件输出

En ​

Enable llms.txt and raw .md file output

Default ​
ts
false

files ​

ts
files: boolean;
Zh ​

是否为每篇文章生成独立的 .md 文件（可通过 /posts/xxx.md 访问）

En ​

Whether to generate individual .md files for each post (accessible via /posts/xxx.md)

Default ​
ts
true

fullText ​

ts
fullText: boolean;
Zh ​

是否生成 llms-full.txt（包含所有文章完整内容）

En ​

Whether to generate llms-full.txt (with all post content inlined)

Default ​
ts
true

include? ​

ts
optional include: string[];
Zh ​

要包含的 markdown 文件 glob 模式（相对于 pages/ 目录）。 默认为 ['posts/**/*.md'] 仅包含 posts。 设为 ['**/*.md'] 可包含所有 pages 下的 markdown 文件。 也可以指定多个目录，如 ['posts/**/*.md', 'guide/**/*.md']。

En ​

Glob patterns for markdown files to include (relative to pages/ directory). Defaults to ['posts/**/*.md'] to only include posts. Set to ['**/*.md'] to include all markdown files under pages/. You can also specify multiple directories, e.g. ['posts/**/*.md', 'guide/**/*.md'].

Default ​
ts
['posts/**/*.md']

prompt ​

ts
prompt: string;
Zh ​

自定义提示词（添加到 llms.txt blockquote 部分）

En ​

Custom prompt text (added to the llms.txt blockquote section)

Default ​
ts
''

Zh ​

llms.txt 及原始 Markdown 文件输出

En ​

llms.txt and raw Markdown file output

See ​

https://llmstxt.org/

mediumZoom ​

ts
mediumZoom: object;

Defined in: packages/valaxy/types/config.ts:340

image preview by medium-zoom

enable ​

ts
enable: boolean;
Zh ​

启用图片预览

options ​

ts
options: ZoomOptions;
Zh ​

配置项

See ​

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

selector ​

ts
selector: string | HTMLElement | HTMLElement[];

For example: '.markdown-body img'

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

Url ​

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

mode ​

ts
mode: "light" | "dark" | "auto";

Defined in: packages/valaxy/types/config.ts:49

enable auto (light/dark mode)

Default ​

ts
'auto'

orderBy ​

ts
orderBy: "date" | "updated";

Defined in: packages/valaxy/types/config.ts:139

order posts by 'date' or 'updated'

  • date: 按创建时间排序
  • updated: 按最后更新时间排序

当开启 lastUpdated 时，updated 会按照文件的更新时间自动赋值

Default ​

ts
'date'

pageSize ​

ts
pageSize: number;

Defined in: packages/valaxy/types/config.ts:377

displayed posts length in every page

Default ​

ts
7

redirects? ​

ts
optional redirects: object;

Defined in: packages/valaxy/types/config.ts:477

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

rules? ​

ts
optional rules: RedirectRule[];

useVueRouter? ​

ts
optional useVueRouter: boolean;
ts
search: object;

Defined in: packages/valaxy/types/config.ts:170

enable ​

ts
enable: boolean;
Zh ​

是否启用

provider ​

ts
provider: "algolia" | "engine" | "fuse" | "local";

Search Type

  • algolia: Algolia Search
  • engine: Engine Search, like Google/Baidu
  • fuse: Local Search by fuse.js
  • local(todo): Local Search by MiniSearch

type? ​

ts
optional type: "algolia" | "engine" | "fuse" | "local";
Deprecated ​

will be deprecated, use search.provider instead

En ​

search engine for your site

Zh ​

搜索功能

social ​

ts
social: SocialLink[];

Defined in: packages/valaxy/types/config.ts:164

社交链接

ts
sponsor: object;

Defined in: packages/valaxy/types/config.ts:311

donate for author

description? ​

ts
optional description: string;

Donate content description

Description ​

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

Default ​
ts
undefined 不显示内容

enable ​

ts
enable: boolean;

methods ​

ts
methods: object[];
Zh ​

赞助方式

title? ​

ts
optional title: string;

Donate button title attribute

Description ​

打赏按钮的 title 属性

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

Description ​

打赏/赞助

statistics ​

ts
statistics: object;

Defined in: packages/valaxy/types/config.ts:383

statistics readingTime and wordCount

enable ​

ts
enable: boolean;

readTime ​

ts
readTime: object;
readTime.speed ​
ts
speed: object;
readTime.speed.cn ​
ts
cn: number;

Chinese word count speed

Description ​

中文每分钟阅读字数

Default ​
ts
300 (300 字/分钟)
readTime.speed.en ​
ts
en: number;

English word count speed

Description ​

英文每分钟阅读字数

Default ​
ts
100 (200 字/分钟)

Description ​

统计阅读时间和字数

subtitle ​

ts
subtitle: string;

Defined in: packages/valaxy/types/config.ts:89

副标题

timezone ​

ts
timezone: string;

Defined in: packages/valaxy/types/config.ts:79

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
''

title ​

ts
title: string;

Defined in: packages/valaxy/types/config.ts:85

Site title

Description ​

站点标题

url ​

ts
url: string;

Defined in: packages/valaxy/types/config.ts:80

vanillaLazyload ​

ts
vanillaLazyload: object;

Defined in: packages/valaxy/types/config.ts:362

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

enable ​

ts
enable: boolean;

options ​

ts
options: ILazyLoadOptions;

See ​

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