🚀 本地调试与部署

本文档介绍如何启动 Angelic Wiki 的本地伺服器


一、服务启动

本站已配置专属的启动逻辑,支持自动分配未占用的随机端口,并自动在浏览器中唤起页面。

1. 方式一:Antigravity IDE / VS Code

  • 直接在IDE中按下键盘 F5 键
  • IDE会自动运行 server.js

2. 方式二:终端命令行

在项目根目录下打开终端,运行:

npm start

或者使用 Quartz 原生指令:

npx quartz build --serve

热重载支持

本地服务启动后具备热重载(Hot Reload)特性,在 content/ 目录下修改或新建任何 Markdown 文章并保存,浏览器页面会自动即时刷新。


二、编译检验

在将文章推送到远程仓库之前,可以先在本地执行一次全量静态构建,检查是否有断链或排版语法错误:

npx quartz build

构建成功后,静态 HTML 文件会输出到 public/ 目录下。


三、向本站提交你的文章(PR 贡献)

任何人都可以给本站投稿或修改错别字,由于是公开仓库,所有人提交后都需要经过审核才会正式发布到网站上。

流程非常简单,在 GitHub 上点几下即可:

  1. Fork 仓库:打开本站 GitHub 仓库,点右上角的 「Fork」,把项目拷一份到你自己的账号里。
  2. 写文章:在你 Fork 的仓库里,在 content/ 目录下新建或修改 Markdown 文章。
  3. 提交 PR:改完后点页面上的 「Contribute」➔「Open pull request」,简单写一两句你改了什么,然后点提交。
  4. 等待合并:看到的人如果觉得没问题,你的文章就会自动编译上线到网站上了!

懒得写代码?

如果你只是发现药理内容有错或者有新建议,直接在 GitHub 仓库顶部的 「Issues」 里面发个帖子告诉我。