返回列表

欢迎使用 Vergil

Vergil 是一套基于 Astro 的内容站点框架。博客、图文动态、项目、知识库、相册放在同一个站点里,提示框、时间线、图表这些排版都写成 Markdown 指令,不用写组件,也不用碰 CSS。

你现在看到的这个站点,就是用 Vergil 搭的。

Vergil 的四种页面

四格分别是:文章里的折叠块与时间线、Golden 主题的相册、带目录树的知识库、按分类筛选的极简模式。

为什么用它

只写 Markdown

51 个内容指令覆盖排版、提示、媒体、图表和计划,写法都一样:三个冒号开头,三个冒号结尾。下面三块就是直接写在这篇文章里的,切到「写法」看源码。

提示框

读者容易略过的信息,放进提示框。

  1. 跑起来

    装好 vg,运行

  2. 改成自己的

    站点名、头像、导航

  3. 写第一篇

    写完推送,自动部署上线

:::callout{type="tip" title="提示框"}
读者容易略过的信息,放进提示框。
:::

:::timeline
- 第 1 天 | 跑起来 | 装好 vg,运行 `vg init my-site`
- 第 2 天 | 改成自己的 | 站点名、头像、导航
- 第 3 天 | 写第一篇 | 写完推送,自动部署上线
:::

:::mermaid
flowchart LR
    A[写 Markdown] --> B[pnpm build] --> C[静态站点] --> D[部署到任意平台]
:::

一篇文章,三种读法

默认视图带着左右侧栏和目录,方便在站内跳转。极简模式去掉两侧,只留正文,文章上方工具栏的「沉浸」按钮一点就进。简历页是一个独立的个人介绍视图,可以直接打印成 PDF。

用极简模式看这篇 打开简历页

配色和皮肤,随手换

配色有好几套,每套都单独调过暗色模式。访客点右上角的主题图标就能切换,现在就可以试试。

皮肤管的是形状和质感:圆角多大、按钮什么样、顶栏贴边还是悬浮,每个皮肤还带着自己的几套配色。主题自带经典皮肤,更多皮肤用 vg skin add <名字> 从 vergil-skins 安装:「海岛」是大圆角、胶囊按钮、悬浮的顶栏、铺一层波点底纹,配暖奶油色;「粗野」是报纸风的直角细框加硬投影,配纸白和荧光绿。装好以后访客在同一个面板里就能切换,切到哪个皮肤,配色就换成它的默认配色。

想让访客一进来看到的就是海岛皮肤,装好以后改一行配置:

src/data/config/identity.ts
export const siteInfo = {    // ...    skin: 'island',     // 默认是 'classic'    skins: ['island'],  // vg skin add island 会自动写上};

开箱即用

深色模式、全文搜索(按 Ctrl+K 试试)、RSS、站点地图、中英文界面都是现成的;评论接好 Giscus 或 Artalk 就能打开。文章里的图片构建时自动压缩成 WebP、写好宽高。构建产物是纯静态文件,Vercel、Netlify、EdgeOne Pages、GitHub Pages 都能直接部署。

还有一些锦上添花的功能,在配置里打开开关就有:

开屏页

首页的全屏轮播背景,你打开这个站时看到的就是它。怎么配置 →

站点助理

打开后,页面左下角会出现一个站点助理,按你所在的页面说一句话,还可以换成 Rive 或 Live2D 模型。它默认是关着的,台词改成你自己的口吻再打开。怎么配置 →

浮动播放器

把当前页面里的音频收进右下角的播放器,点顶栏的音乐按钮打开,可以固定展开。怎么配置 →

在线工具箱

JSON 解析、文本对比、图片转 WebP,全部在浏览器里运行,数据不会上传。打开工具箱

另外还有 标签页 底部可以拖着转的 3D 标签星球,以及接入 Umami 后的 站内访问统计。

站里都有什么

点缩略图直接进入对应的页面。

博客

博客

长文章,用专栏、分类、标签组织。

图文动态

图文动态

随手拍、短句子,像发朋友圈。

想法

想法

碎片笔记,按时间串起来。

项目

项目

作品展示,带技术栈和链接。

知识库

知识库

成体系的文档,带目录树和上下篇。

相册

相册

黑金 和 四季 两套主题,灯箱浏览,显示拍摄参数。

三步开始

01跑起来

装好 vg 命令,用它建站:放入示例站、装好依赖、启动开发服务器,一条命令做完。

终端
npm install -g @vergil-astro/vergil-clivg init my-site

02改成你的

站点名、首页介绍、导航、页脚、头像,改完这 5 处就是你的站点。

src/data/config/identity.ts
export const siteInfo = {    title: '我的博客',    subtitle: '记录技术与生活',    // ...};

03清掉示例,开始写

先预演看看会删什么,再一键清掉演示内容,然后写你的第一篇。

终端
pnpm reset:drypnpm reset

每一步怎么做,专栏 搭建你的第一个站点 会一篇一篇带你走完,从 第一篇 开始。

遇到问题

所有功能的完整用法都在站内文档里,GitHub 上可以提问题。

快速开始 内容指令 站点配置 GitHub