❤️ 参与贡献
明信片百科 是基于 VitePress 构建的明信片百科知识库,由 AngeloFan 主导开发,同时负责 Pull Request(拉取请求)的审核合并等工作;Post‑Hi 为本项目提供服务器部署、域名、CDN加速等基础设施资源支持。
源码全部公开,任何人都可以阅读、查阅、提交修改完善百科内容。
项目简介
明信片百科,致力于收集整理明信片相关词条、圈内行话、互寄玩法、书写教程、品类科普等资料,打造开放的明信片开源百科。
项目采用 VitePress 2 (Vite 打包,ESM 模块模式),源码全部公开,任何人都可以阅读、查阅、提交修改完善百科内容。
贡献所需技能
根据参与方式不同,所需技能门槛不同
✨ Gitee在线编辑(新手模式)
- 基础阅读与简单 Markdown 能力:掌握标题
##、列表-、加粗**文字**、引用>即可;不需要搭建本地环境。 - 熟悉明信片圈子相关知识,保证词条内容客观准确。
- 会简单描述修改意图,填写修改说明。
💻 本地克隆开发(批量修改/预览站点,进阶)
- Markdown 语法:熟练使用本项目文档使用的语法:标题层级、无序列表、加粗、引用块、内部/外部链接、代码块;本项目所有百科文档均遵循统一格式规范。
- Git 基础操作:fork、clone、提交推送、发起 Pull Request。
- Node.js 环境部署,能够执行 npm 命令运行开发预览服务。
- 可选:了解 VitePress 基础结构,不建议随意修改
.vitepress站点配置目录。
提示:所有新增/修改的词条,需要遵循百科统一格式:yaml头部、一级标题、二级条目、
✅定义 / 📌圈内特点 / ⚠️注意 / 🤝礼仪 / 🎯适用场景这套固定写作范式。
如何参与协作
欢迎各类贡献:新增词条、修正错误、补充图文资料、优化排版、完善文档。
两种参与方式:页面底部Gitee在线编辑(新手首选)、本地完整开发(批量修改/预览站点)。
仓库链接:https://gitee.com/post-hi/com.post-hi.baike
✨ 在线编辑(无需本地环境,新手首选)
站点每一篇文档页面底部均带有「在线编辑」跳转按钮,适合修改少量文字、纠错、补充小段内容:
- 打开需要修改的百科页面,点击页面底部的 在线编辑,自动跳转至 Gitee 编辑界面
- 若未登录 Gitee,会引导你完成账号登录并自动 Fork 仓库至你的个人账号
- 在编辑页修改文档内容,填写简短清晰的修改说明,描述本次改动
- 提交保存,系统会自动帮你发起 Pull Request
- 维护者审核通过后,合并至主仓库,站点重新构建后内容即可上线。
新增词条:需要前往 Gitee 仓库,在
docs/对应分类目录新建.md;图片资源存放在docs/public/。 尽量不要直接修改.vitepress目录下的站点配置文件。
💻 本地克隆开发(适合大量编辑、本地预览效果)
项目使用 VitePress 2,type: module ESM 模块模式。
环境要求
- Node.js 18+
- Git
bash
# 1. Fork 本仓库到自己 Gitee 账户,克隆你 Fork 后的仓库到本地
git clone https://gitee.com/你的用户名/com.post‑hi.baike.git
cd com.post-hi.baike
# 2. 安装依赖
npm install
# 3. 启动本地开发服务(实时重载)
npm run docs:dev修改完成后提交保存到你的 Fork 仓库,然后:
- 在你的仓库发起 Pull Request,向原仓库提交合并请求
- 维护者审核通过后,合并至主仓库,站点重新构建后内容即可上线。