进阶贡献
文件结构
写文章只需要关注有编号的文件夹,如01.新生入学/;docs/public/只有在需要改动站点图标时才需要动。其余内容请自行查看相关项目文档或者询问AI,但是修改需谨慎。
docs/public/只保留站点图标等少量静态资源,不要再往里面放文章图片;有编号的文件夹里面的 .md 文件就是网站上的文章。
文章图片统一存放在远程图片服务 https://img.ncepuinfo.cc/,通过图片上传器管理,添加、处理图片的方法见下一节。
以下结构并不全面,只显示一些比较重要的,更深入的了解网站结构请自行访问Github
NCEPUwiki/
├─ docs/ # 站点正文,最重要的目录
│ ├─ .vitepress/ # VitePress 配置、目录索引和主题
│ ├─ public/ # 站点图标等少量静态资源(文章图片不放在这里)
│ │ └─ img/ # 仅保留 logo、school 等站点图标
│ ├─ index.md # 首页内容
│ ├─ 01.新生入学/ # 新生向内容
│ │ ├─ 01.新生-入学准备.md
│ │ ├─ ...
│ │ └─ 10.Q&A.md
│ ├─ 02.学习专题/ # 学习与升学专题
│ │ ├─ 01.北京校区专业指南/
│ │ └─ ...
│ ├─ ...
│ └─ 10.贡献/ # 给贡献者看的协作说明文章图片:上传、处理与引用
正文里的图片统一使用 https://img.ncepuinfo.cc/ 下的公开链接,图片的上传、删除、移动等操作都在图片上传器里完成。上传器只管理远程图片,不会修改仓库里的 Markdown。
上传前先处理
- 截图尽量只截必要区域(Windows 可用
Win + Shift + S,也可以使用 Snipaste、ShareX 等工具),不要把无关的浏览器标签、工具栏、通知和桌面一起截进来。 - 上传前检查并遮挡敏感信息:姓名、学号、手机号、证件号、群二维码、限时邀请链接等。
- 上传器支持 JPG、PNG、WebP、GIF、AVIF,单张不能超过 10MB。界面截图以及含文字、表格的图片建议用 PNG 或 WebP 保存,照片用 JPG,动图用 GIF 或 WebP。
- 上传器目前不会自动压缩、转 WebP 或清除 EXIF,体积太大时先在本地处理(例如裁剪,或使用 Squoosh、TinyPNG 等压缩工具)再上传。
上传并获取链接
- 打开 https://upload.ncepuinfo.cc,按页面提示登录。
- 如果文章已经配过图,在“图片库”里逐级进入它的目录(目录按编号分层)。例如要给
docs/03.计算机知识专题/08.踏入AI高阶之路.md配图,就依次进入03 → 08。 - 点工具栏的“上传”(旁边的 ▾ 可切换“上传文件夹”),选择单张或多张图片;也可以直接把图片拖进当前目录,或复制图片后直接粘贴。
- 图片会先进入待批准状态,owner 批准后才公开。批准后复制生成的图片链接即可使用。
如果文章是第一次配图、图片库目录里还没有它:保持在“全部”页面点“上传”,选择图片后按“栏目 → 子栏目 → 文章”选择目标文章;还没推送到仓库的新文章可以点“+ 没有我要的文章?手动输入”填写路径。
图片会自动按“栏目编号 / 文章编号 / 内容哈希.原扩展名”存放,不需要手动起文件名。例如 docs/03.计算机知识专题/08.踏入AI高阶之路.md 上传的图片会得到类似 https://img.ncepuinfo.cc/03/08/<hash>.png 的链接;同一张图片重复上传会直接复用已有链接。
在文章中插入图片
正文里使用 Markdown 语法插入,alt 中写一句图片内容说明:
需要控制图片显示大小时,改用 HTML 的 <img> 标签:
<img src="https://img.ncepuinfo.cc/02/06/<hash>.png" alt="图1:选课入口" width="400" />注意:
- 网站会自动给文章里的图片加上“点击在新标签页打开原图”,不需要再手动包一层链接。
- 不要再使用
/img/...或docs/public/img/...引用文章图片,图片要等 owner 批准后才能公开访问,PR 合并前请先确认链接可以打开,避免上线后出现失效图片。 - 引用外站图片(例如官网截图)时,若图片来源不稳定或可能失效,建议先传到本站图床再引用。
修改、移动与删除已有图片
- 在上传器里进入“图片库”浏览已有图片,选中图片或文件夹后提交删除、移动、重命名等申请,owner 批准后才真正生效。
- 所有申请都可以在“我的申请”里查看处理进度,处理需要等待 owner,不是提交后立刻生效。
- 图片路径变化后,记得同步更新文章里的引用,避免留下失效链接。
- 替换旧图时,建议先上传新图并把文章引用改成新链接,再提交旧图的删除申请,避免页面短暂出现空图。
项目贡献流程
Github Fork
如果你是第一次贡献,请先将项目Fork到个人仓库然后进行贡献
Fork后会在个人仓库看见 NCEPUwiki Repository,即为Fork成功。
01.同步修改
由于wiki更新频率较高,在进行修改前请先通过 Sync fork 同步他人的修改。
02.编辑内容
在同步之后,可以直接在Github网页对文件进行修改,如删除、添加,这种情况适用于自己先写好文章,最后只需要上传一下。
也可以使用 Git 工具(此工具的使用请参考文章 Git教程),将项目 clone 到本地修改,最后在同步到个人仓库。
03.提交Pull Request
将修改内容同步到个人仓库后,点击仓库主页的 Contribute -> Open pull request ,即可将你的修改提交到NCEPUwiki主仓库,等待项目管理员审核批准,若有问题会及时评论,请及时修改。
更详细的流程请参考文章 Git教程的结合Github、Vscode和git进行项目开发 部分




