::: zh-CN
视频教程:
文字教程:
Valaxy官网
前情提要
为什么选择Valaxy
这边我引用Valaxy官网的一段话为什么是 Valaxy?
构想新一代静态博客框架/生成器。
「告诉你两件好事吧」:
第一它与 Hexo 相比开发体验和速度上都更胜一筹
第二它与 VitePress/VuePress 相比拥有更多针对博客的集成功能,譬如文章列表钩子、自动路由与组件注册、可覆盖的布局与主题等。
我认为 Valaxy 最突出的优势在于它的热更新开发体验与可定制性,但你编写文章或博客配置时,你只需要保存,所有的变更将会即刻显示在页面上,几乎无需等待!
此外,Valaxy 的主题还较少,但以 valaxy-theme-yun 为例,你可以覆盖主题中的任何组件,来定制或编写你自己的主题。
由于我自己在搭建这个博客上踩过很多的坑,尝试搜索也没有很多的教程,只能靠着自己和开发文档一点一点摸索,我感觉我应该为博客圈做些什么……
创建Valaxy
环境配置
首先你需要有Node.js 16+的版本才可以进行Valaxy的搭建
你可以点我进入Node.js官网
安装Valaxy
由于大部分用户都为Windows系统,所以这里以Windows为例
创建项目文件夹
当然,我们不能直接进行部署,首先我们需要创建一个项目文件夹来存储我们项目开发时的文件
这里在你喜欢的地方创建一个文件夹,名称随意,但是切记,尽量不要出现中文和空格,不然后期会很烦人,打开它
我在这里以blog为例
创建好之后,双击文件夹的地址栏,输入cmd,打开命令行,以下的操作均在命令行中完成
创建Valaxy项目
1 | # 安装pnpm |
把上面我给出的两条指令打进命令行中,以拉取最新的Valaxy项目(这里我把命令行的颜色改为紫色,以便更好地查看)
这里提示选择拉取的项目
因为我们是做个人博客使用,所以这里选择Blog:
这里提示我们输入博客文件夹的名称,我们默认即可,当然你也可以选择自定义的名称:
这里会提示我们选择是否需要安装,我们输入y:
按上下方向键选择安装使用的代理,这里选择 pnpm,回车:
酱酱!我们很简单的就完成了Valaxy的搭建
这里我们输入o可以快速打开网页预览
输入e可以自动打开VSCode进行编辑
小白看过来!
什么是VSCode?
Visual Studio Code,一款炒鸡方便的代码编辑器,建议大家人手一个
编辑配置
目录结构
pages: 所有页面
posts: 博客文章,文件格式为markdown
public: 静态资源文件夹,可以直接在文章中引用
styles: 覆盖主题样式,文件夹下的 index.xxx 文件将会被自动加载
components: 自定义你的组件
layouts: 自定义布局
locales: 自定义国际化关键词
valaxy.config.ts: 用户配置文件
site.config.ts: 站点配置文件
valaxy.config.ts
在我们初次打开VSCode之后,右下角会提示下载一些插件,直接选择安装
安装完成后,我们把鼠标悬浮在代码之上,就会看到一些简易的注释
您可以选择根据Valaxy官网开发文档进行配置,也可以参考我的配置文件:
1 | import type { UserThemeConfig } from 'valaxy-theme-yun' |
site.config.ts
1 | import { defineSiteConfig } from 'valaxy' |
插件
评论区(以Twikoo为例)
安装依赖
1 | pnpm add valaxy-addon-twikoo |
加载插件
1 | import type { UserThemeConfig } from 'valaxy-theme-yun' |
Twikoo的配置请查看Twikoo官方文档
Vue配置
如果你需要自定义Vue的组件,可以把组件放到/components文件夹下
如果你不知道Vue是什么,请查看Vue官方文档
但是我不喜欢把文件分散放,所以我直接在原本的Valaxy主题文件中放置了我的Vue
路径:\node_modules\valaxy-theme-yun\components
这里推荐几个我自己写的Vue组件,希望可以帮到你
- 网站页脚插入更多的链接
1 | <script lang="ts" setup> |
- DomainCheck.vue帮助你更好的检测你的网站是否被盗用
原理就是检测用户进入的域名是否为你设置的域名,不是的话提示并且让用户跳转
1 | <template> |
- NoticeBar.vue公告栏组件
1 | <script lang="ts" setup> |
当然我就是一瓶不满半瓶晃荡,我不能保证我写的代码是最好的,但是起码是能用的
另外,千万不要忘了在YunFooter.vue和home.vue中引用你的自定义组件
1 | <script lang="ts" setup> |
像这样就可以引用你刚才的组件了
部署
自行部署
使用以下命令构建打包:
1 | npm run build |
将 dist 文件夹下的内容部署到自己的服务器上。
GitHub Pages部署
可自行搜索或者观看我的教程视频
最后的最后,感谢您的浏览,如有什么其他的问题,欢迎在评论区向我提问,我看到后会在第一时间回复您
:::
::: en
Technical teaching articles cannot be translated into English. Please understand
::: warning
This content is translated from Chinese by a machine and may contain unrealistic information
:::
:::