开始

总览 ​

Valaxy = V + Galaxy 旨在成为下一代静态博客框架，提供更好的热更新与用户加载体验、更强大更便捷的自定义开发可能性。

你可以在 为什么选 Valaxy 中了解更多关于项目的设计初衷。

创建 Valaxy 项目 ​

示例: yun.valaxy.site

在线试用 ​

你可以通过 StackBlitz 在线试用 Valaxy（默认使用主题 valaxy-theme-yun）。

这是一个极简项目，您仅需以下几个文件，就可以快速搭建好你的博客！

• pages 文件夹：存放页面/文章
• valaxy.config.ts Valaxy 配置文件
• package.json 记录依赖

在本地创建 ​

如果您想要在本地创建，只需要执行以下命令：

由于 npm init 会缓存您此前下载的版本，我更推荐您使用 pnpm 来创建模版。 安装 pnpm

  🌌 Valaxy  v0.28.0-beta.1

? Select a type: › - Use arrow-keys. Return to submit.
❯   Blog - For Most Users 【Press Enter】
    Theme - For Theme Developers
    Addon - For Addon Developers

? Project name: › valaxy-blog 【Press Enter】
  📁 /root/repos/valaxy-blog

  Scaffolding project in valaxy-blog ...
  Done.

? Install and start it now? › (Y/n) Press Y

? Choose the agent › - Use arrow-keys. Return to submit.
    npm
    yarn
❯   pnpm 【Press Enter】

跟随命令行提示完成创建！

默认使用主题 valaxy-theme-yun，当然您也可以安装使用任意其他主题。 本文档同样是一个 Valaxy 主题 valaxy-theme-press，它的灵感来自 VitePress。

使用 ​

进入你创建好后的文件夹目录后，执行以下命令。 譬如：cd valaxy-blog。

安装依赖：

启动预览：

博客创建完毕，查看本地 http://localhost:4859/，玩的开心！

• Valaxy 博客通用的配置可参见 配置 与 自定义扩展。
• Valaxy 主题独有配置请参见对应主题文档。（Valaxy Theme Yun 主题文档编写中……）

配置 ​

修改 valaxy.config.ts 来自定义你的博客吧。

基础配置可参见 配置。

文档正在不断完善中！

部署 ​

部署可参见 部署｜指南。

升级 ​

pnpm ​

你可以使用 pnpm 的交互升级命令。

迁移 ​

如果你来自其他博客框架，可参考 迁移。

目录结构 ​

在大部分情况下，你只需要在 pages 文件夹下进行工作，编写文章。

主要的文件夹 ​

• pages: 你的所有页面
  • posts: 写在 pages/posts 文件夹下的内容，将被当作博客文章
• styles: 覆盖主题样式，文件夹下的这些 scss 文件将会被自动加载
  • index.ts / index.scss / index.css
• components: 自定义你的组件（将会被自动注册）
• layouts: 自定义布局 (譬如可以通过 layout: xxx 来使用 layouts/xxx.vue 布局)
• locales: 自定义国际化关键词

其他 ​

• .vscode: 推荐安装一些有用的 VSCode 插件，这样你可以直接预览一些图标、国际化、辅助的 CSS Class 等
  • 你可以在 VSCode 插件商店中找到 Valaxy 插件，它提供了文章列表预览/切换/删除等功能，让你尽可能地可以在 VSCode 中完成所有操作。
• .github: 使用 GitHub Actions 自动构建并部署到 GitHub Pages
• netlify.toml: Netlify 自动配置
• vercel.json: Vercel 重定向配置

主题 ​

如果您希望自己开发一个主题并发布，您可以参考 valaxy-theme-starter。

更多内容请参见 如何编写一个 Valaxy 主题。

社区 ​

如果你有疑问或者需要帮助，可以到 Discord 和 GitHub Discussions 社区来寻求帮助。