零鹊文档

面向团队与社区的原生 PHP 文档站:分类导航、增强 Markdown、后台可视化编辑,并与零鹊图床联动插图。

适合:游戏服/产品说明、教程、API 说明、公告与编写规范集中发布。


能做什么

能力 说明
文档中心 分类组织页面,左侧目录 + 正文阅读
增强 Markdown 标准语法 + 短代码(HTML/CSS/PHP/嵌入页等),详见《编写指南》
阅读体验 深浅色主题、代码块一键复制、正文图片点击放大、标题锚点
首页 可配置服务器信息、公告、入口卡片;几何动效背景
管理后台 页面/分类 CRUD、排序、发布/草稿、站点设置
图床插图 配置零鹊图床后,编辑器内上传图片自动插入 Markdown
数据存储 SQLite 单文件数据库,便于备份与迁移

技术栈:PHP 8+、SQLite、无重型框架;前台 Web 根目录为

public/


读者怎么用

  1. 打开文档站首页,进入 文档中心

    /docs.php

    )。
  2. 在左侧选择分类,再点具体页面;或直接通过分享链接打开

    page.php?id=...

  3. 长文可使用右侧/文内目录(若页面已生成标题结构)快速跳转。
  4. 代码块右上角 复制;图片可点击全屏预览。

作者 / 管理员怎么用

登录后台

  • 地址:

    /admin/login.php

    (部署在域名根下则为

    https://你的域名/admin/login.php

  • 首次空库安装使用

    includes/config.php

    中的默认账号,上线后务必在后台修改密码

常用功能

模块 路径 作用
页面管理

/admin/pages.php

新建、编辑、发布、分页列表
分类管理

/admin/categories.php

分类名称、排序
站点设置

/admin/settings.php

站名、公告、联系方式、零鹊图床 API
修改密码

/admin/password.php

管理员密码

编辑页面时支持 编辑 / 预览 切换;预览会渲染 Markdown 与短代码(PHP 块在预览中不执行,仅展示)。

编写规范

站内详细语法见 《零鹊文档 编写指南》(项目内

docs_guide.md

,也可在文档站单独发一篇「编写指南」页面)。

涵盖:标题锚点、表格、代码块、图片、以及

[html]

[css]

[php]

[embed]

等扩展语法。


与零鹊图床配合

插图推荐使用 零鹊图床,直链稳定、支持在文档编辑器中一键上传。

文档站(站点设置)

配置项 示例
图床 API 地址

https://img.lingque.sxteam.org/api/upload.php

上传令牌 与图床后台

upload_token

一致

图床站(设置)

  • CORS 允许来源:填写本文档站的完整来源,例如

    https://doc.mcimg.com

    https://docs.lingque.sxteam.org

配置完成后,在 页面编辑 工具栏会出现 「上传图片」,自动插入

![...](图床直链)

图床使用说明可另见文档站页面:《零鹊图床介绍》。


站点结构(给部署者)

项目根目录/
├── public/          ← Web 服务器根目录指向这里
│   ├── index.php    首页
│   ├── docs.php     文档中心
│   ├── page.php     单篇文档
│   └── admin/       管理后台
├── data/            SQLite(须可写)
├── includes/        业务与渲染逻辑
└── templates/       前台/后台模板

迁移与权限说明见项目内

DEPLOY.md


发布与备份建议

  • 重要变更前备份

    data/site.db

    public/uploads/

    (若使用本地上传)。
  • 分类与页面的 排序 数字越小越靠前,可用来固定「介绍」「编写指南」等置顶页。
  • 草稿状态页面仅后台可见,确认无误后再勾选发布。

相关链接

名称 说明
零鹊图床 https://img.lingque.sxteam.org
图床 API 图床站内导航「API」
编写指南 文档站内《零鹊文档 编写指南》或

docs_guide.md


常见问题

改完前台看不到?
确认页面已发布;浏览器强刷或清缓存;检查是否改错环境/数据库。

图片上传按钮不显示?
站点设置 填写完整的图床 API 地址;并配置令牌与图床 CORS。

代码块复制无效?
需通过 HTTPS 或 localhost 使用剪贴板 API;HTTP 环境会尝试降级复制,仍失败时请手动选择代码。

表格太宽被挡住?
前台已为表格自动加横向滚动容器;移动端可左右滑动查看。


小暴技术团队 · 零鹊文档

最后更新:2026-06-14 05:12:34