跳到内容

写一页文档

在网页上改一页文档并提交,全程不需要在你电脑上装任何东西。

概览

本站的每一页都能直接在浏览器里编辑。你改完提交,系统会用你自己的 GitHub 账号开一个 Pull Request,维护者看过之后合并,改动就上线了。

你不需要这个仓库的写权限,也不需要装 Git、Node 或任何命令行工具。 想改错别字、补一段内容、加一整页,走这条路就够。

要改导航结构、批量动图片、或者改站点代码,那需要把仓库拉到本地,做法见配一台能跑本站的电脑

打算让 AI 帮你起草,先读用 AI 帮忙写文档

第一步:打开要改的那一页

https://docs.nbtca.space 上翻到你想改的页面。用站内搜索找最快。

第二步:登录

页面上有“登录后在本页编辑”的入口。点它会跳到 GitHub 授权,用你自己的账号登录并同意即可。

没有 GitHub 账号的话先去 https://github.com 注册一个,用教育邮箱注册还能顺带拿学生优惠。

看到什么算成功:跳回文档站,入口文字变成“在本页编辑”。

第三步:改

点进去是一个编辑框,左边写、右边实时看效果。

  • 语法照 Markdown 写,常用的几种见 Markdown
  • 要插图直接把图片拖进编辑框,系统会自动转成 WebP 并放好。
  • 页面开头两行 --- 之间是元信息,不要动,除非你清楚自己在改什么。

写不下去、想留个空缺给以后的人,直接写清楚缺什么,不要编。归档页有专门的标记,见编者按标记

第四步:提交

点“提交”。系统会用你的账号复制一份仓库,把改动放进去,然后自动开一个 Pull Request。

看到什么算成功:给出一个 PR 链接,点进去能看到你的改动。

第五步:等评审

维护者会在那个 PR 里回复。需要改就继续在网页上改、再提交一次,同一个 PR 会自动更新,不用重开。通过之后由维护者合并。

PR 下方有一排自动检查。变红不代表你写错了内容,多半是格式问题,点进去能看到具体是哪一条,对照 Markdown改。

新建一页

入口是“登录后新建一页”。系统会让你先选这一页属于哪个板块,每个板块旁边写着什么内容属于这里、该怎么写。选完给你一个空文档和一份骨架。

文件名会先生成一个 draft- 开头的临时名字。这个名字就是这一页将来的网址,提交前改成一个稳定、能长期用的名字,全小写、用连字符分词。

写作上的几条硬要求

  • 站内链接以 / 开头,例如 /tutorial/markdown
  • 引号用 “”,不要用 「」
  • 加粗紧邻标点有个坑,见强调的边界规则
  • 图片要写 alt,描述画面本身,写给读不到图的人;
  • 拿不准的事实宁可留空也不要猜。

卡住了看哪里

情况去这篇
不确定某种语法怎么写Markdown
想用容器、代码组、图注组件VitePress
PR、评审、标签在 GitHub 上怎么点GitHub 工作流
想弄清 PR 到底是什么Git 的理念与模型

还是不行就在群里问,或者开一个 Issue。你卡住通常说明这份手册没写清楚,欢迎顺手补上。