如何编辑网站内容
这篇说明给组内成员使用。你不需要会 Git、命令行、VS Code 或 Docusaurus 配置,只需要会打开网页、登录 GitHub、填写表单和等待审核。
谁可以编辑
只有被加入本 GitHub 私有仓库的组内成员可以编辑。请使用自己的 GitHub 账号登录,不要共用账号。
如何进入后台
打开网站后台地址:
/admin
如果网站地址是 https://example.com,后台就是 https://example.com/admin。
如何登录 GitHub
进入后台后,点击登录按钮,按页面提示授权 GitHub。第一次登录时,GitHub 可能会要求你确认授权;请确认账号是自己的组内 GitHub 账号。
如果登录失败,通常是因为你还没有被加入仓库,或者 GitHub OAuth 还没有配置好。请联系网站维护者。
如何新建文章
登录后,在左侧选择你要编辑的栏目,例如“湿实验 SOP”“软件与仿真”或“科研动态 blog”,然后点击新建。
每次只新建或修改一篇文章会更容易审核。如果一次改很多篇,审核者很难判断哪些内容需要修改。
如何填写标题、slug、简介和正文
标题可以写中文,例如“细胞传代 SOP”。
slug 是英文文件名,请使用英文小写、数字和短横线,例如:
cell-passage-sop
comsol-flow-model
new-paper-published
不要使用中文 slug,不要使用空格,不要使用下划线。slug 会影响网页地址和文件名,保持短、清楚、英文会更稳定。
简介用于搜索结果、页面摘要和后台列表,建议用一两句话说明这篇内容解决什么问题。
正文用 Markdown 编辑。你可以直接写普通文字,也可以使用标题、列表、表格和图片。
如何上传图片
在正文编辑器里插入图片时,可以上传本地图片。图片会保存到网站的统一上传目录。
请注意:
- 图片不要太大,建议先压缩到网页合适大小。
- 不要上传无关图片、重复图片或原始超大显微图。
- 图片文件名建议使用英文、数字和短横线。
如何保存草稿
编辑过程中可以先保存为草稿。草稿不会立刻出现在网站上,其他人也不会马上看到正式页面变化。
保存前请检查标题、slug、简介、正文和图片是否完整。
如何提交审核
文章写完后,在后台提交审核。提交后系统会把你的修改保存到 GitHub,并进入审核流程。
请不要直接修改 main 或 master 分支。网站内容需要经过 Pull Request 审核后再合并。
为什么不会立刻显示在网站上
提交审核不等于发布。你的修改需要维护者检查内容、格式、图片和链接,确认没有问题后才会合并。
合并后,Vercel 会自动重新部署网站。部署完成后,新内容才会出现在正式网站上。
常见问题
我提交后看不到文章
这是正常的。文章需要等待审核、合并和 Vercel 部署。
slug 写错了怎么办
如果还没提交审核,可以直接修改。如果已经提交,请在后台继续修改同一篇文章,或联系维护者帮你调整。
可以用中文文件名吗
不建议。标题可以写中文,但 slug 请用英文小写和短横线。
图片上传失败怎么办
请先检查图片是否太大,文件名是否有特殊符号。仍然失败时,请联系维护者。
我可以一次改很多篇吗
不建议。每次只改一篇文章更容易审核,也更容易发现问题。
内容什么时候会正式上线
提交审核后,需要等待维护者审核合并。合并后 Vercel 会自动部署,通常几分钟后可以看到。