chore: prepare open source archive
This commit is contained in:
@@ -1,8 +1,6 @@
|
||||
# SuBlog
|
||||
|
||||
尼克的小窝 — 个人技术博客
|
||||
|
||||
🔗 官方网站:[https://nixus.top/](https://nixus.top/)
|
||||
基于 Nuxt 3 的个人技术博客模板。
|
||||
|
||||
## 为什么做这个
|
||||
|
||||
@@ -35,6 +33,9 @@
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
# 创建本地站点配置(该文件不会提交到 Git)
|
||||
cp config/site.ts.example config/site.ts
|
||||
|
||||
# 安装依赖
|
||||
pnpm install
|
||||
|
||||
@@ -60,7 +61,8 @@ pnpm new-post <文章名称>
|
||||
├── components/
|
||||
│ ├── layout/ # 导航栏、页脚、主题切换、3D 技术栈头像
|
||||
│ └── blog/ # 文章卡片、目录、评论
|
||||
├── config/site.ts # 全站配置(改这一个文件就行)
|
||||
├── config/site.ts.example # 可提交的安全配置模板
|
||||
├── config/site.ts # 本地私有站点配置(Git 忽略)
|
||||
├── content/posts/ # Markdown 文章
|
||||
├── pages/ # 页面路由
|
||||
├── public/ # 静态资源
|
||||
@@ -70,7 +72,11 @@ pnpm new-post <文章名称>
|
||||
|
||||
## 配置
|
||||
|
||||
所有站点配置集中在 `config/site.ts`,站点名称、头像、社交链接、导航菜单、友链、赞助、Giscus 都在这里改,改完自动生效。首页头像使用 `components/layout/AvatarOrbit.client.vue` 渲染,技术栈图标、颜色、动画节奏在该组件内维护。
|
||||
所有个性化信息集中在本地的 `config/site.ts`:站点资料、社交链接、项目反馈地址、友链、赞助名单、收款码路径、备案信息和 Giscus 标识。该文件已被 Git 忽略,仓库只提交 `config/site.ts.example`。
|
||||
|
||||
收款二维码请放在 `public/sponsors/qrcode/` 后,再在 `config/site.ts` 填写路径;该目录同样不会提交到 Git。Giscus、收款码和备案信息留空时,对应页面内容会自动隐藏。
|
||||
|
||||
更多归档前检查项见 [开源配置说明](docs/open-source-configuration.md)。首页头像使用 `components/layout/AvatarOrbit.client.vue` 渲染,技术栈图标、颜色、动画节奏在该组件内维护。
|
||||
|
||||
## 部署
|
||||
|
||||
@@ -80,6 +86,6 @@ pnpm generate
|
||||
|
||||
产物在 `.output/public` 目录,直接丢到 Nginx、Vercel、Netlify 或者 1Panel 都行。
|
||||
|
||||
## 开源计划
|
||||
## 开源归档
|
||||
|
||||
目前代码还不够整洁,等整理好了会考虑开源。如果你对这个项目感兴趣,欢迎先访问 [官方网站](https://nixus.top/) 看看效果。
|
||||
提交前请确认 `config/site.ts`、`.env*` 和 `public/sponsors/qrcode/` 没有被强制加入 Git;仓库内不应包含个人账号、备案信息或收款码。
|
||||
|
||||
Reference in New Issue
Block a user