GMI(Mental Illness Guide)是一个基于 MkDocs 与 mkdocs-material 构建的中文精神健康知识库。目标是为公众提供系统、可靠、易理解的精神疾病信息与就医指引,减少污名化,促进理解与支持。
- 分组导航:在“疾病介绍”下按专题分组,信息更清晰易找
- 情绪障碍:抑郁、双相、躁狂、双相快速循环
- 焦虑障碍:总览、强迫(OCD)、PTSD、社交焦虑
- 神经发育障碍:ADHD、ASD
- 进食障碍:厌食、贪食、暴食
- 物质使用障碍、睡眠障碍
- 性别认同与跨性别:性别焦虑、跨性别支持与资源
- 药物指南扩展:新增“药理分类与安全监测”,汇总 SSRIs/SNRIs、抗精神病药、心境稳定剂等的随访与风险提示
- 页面可操作性:各专题均新增“就医路径与患者自助清单”
- 现代体验:中文搜索、响应式、暗黑模式、导航与代码复制等增强特性
- Python 3.11+(建议)
- pip
pip install -r requirements.txt如本地中文搜索报错,请安装/升级以下依赖:
pip install --upgrade "lunr[languages]" nltk scikit-learn pandas numpymkdocs serve
# 仅本机访问:http://127.0.0.1:8000/若希望同一局域网多设备访问:
mkdocs serve -a 0.0.0.0:8000
# 其他设备使用 http://<你的IPv4地址>:8000/
# 如被阻止,请在 Windows 防火墙放行端口 8000 或允许 python.exe 网络访问提示:部分环境会阻断 Google Fonts 加载,属非关键资源,页面仍可正常使用。
- 本机预览(仅本机):
mkdocs serve - 局域网预览(同网段可访问):
mkdocs serve -a 0.0.0.0:8000 - 构建静态站点:
mkdocs build - 清理后重新构建:
mkdocs build --clean - 严格模式(将警告视为错误):
mkdocs build --strict - 查看版本与诊断:
mkdocs --version - 手动部署到 GitHub Pages(可选,Actions 已自动部署):
mkdocs gh-deploy --force - 预览已构建站点文件夹:打开
site/index.html
- 中文搜索报依赖错误:
pip install --upgrade "lunr[languages]" nltk scikit-learn pandas numpy - 局域网无法访问:使用
mkdocs serve -a 0.0.0.0:8000并在防火墙允许端口8000 - 日志提示 “no git logs”:为未提交文件提示,不影响构建;已配置时间回退,正常使用
GMI/
├── .github/workflows/deploy.yml # GitHub Pages 自动部署
├── docs/ # 所有 Markdown 内容
│ ├── index.md # 首页与快速入口
│ ├── emergency.md # 紧急帮助
│ ├── anxiety/ # 焦虑障碍(OCD/PTSD/社交焦虑等)
│ ├── neurodevelopmental/ # 神经发育障碍(ADHD/ASD)
│ ├── eating-disorders/ # 进食障碍(厌食/贪食/暴食)
│ ├── substance-use/ # 物质使用障碍总览
│ ├── sleep-disorders/ # 睡眠障碍总览
│ ├── gender-identity/ # 性别焦虑与跨性别支持
│ ├── medications/ # 药物指南与药理分类索引
│ ├── treatment-methods/ # 治疗方法分专题
│ └── ... # 诊断标准、学习资源等
├── mkdocs.yml # 站点配置与导航
├── requirements.txt # Python 依赖
└── README.md # 项目说明
推送到 main 或 master 分支后,GitHub Actions 会自动构建并发布到 GitHub Pages(见 .github/workflows/deploy.yml)。
- 连接 GitHub 仓库(推荐)
- Build command:
pip install -r requirements.txt && mkdocs build - Output directory:
site - 环境:
Python 3.11;如需中文搜索,请在构建镜像里安装:pip install "lunr[languages]" nltk scikit-learn pandas numpy
- Build command:
- 本地命令发布(Wrangler)
- 安装 Wrangler(需 Node.js/npm)
npm install -g wrangler
- 构建静态站点
mkdocs build --clean
- 创建 Pages 项目(仅首次)
wrangler pages project create gmi-guide
- 发布到 Pages
wrangler pages publish ./site --project-name gmi-guide
- 绑定自定义域名(可选)
wrangler pages domain add gmi-guide <your-domain>
- 若使用 API 令牌方式,需在环境中配置:
CLOUDFLARE_API_TOKEN与CLOUDFLARE_ACCOUNT_ID
- 安装 Wrangler(需 Node.js/npm)
我们欢迎任何形式的贡献:补充页面、改进内容结构、纠错与术语优化等。
- Fork 仓库并创建分支:
git checkout -b feature/your-feature - 开发与预览:
mkdocs serve - 提交更改:
git commit -m "feat: your change" - 推送并创建 Pull Request
欢迎提出扩展建议:例如 BDD(躯体变形障碍)、恐慌障碍、广泛性焦虑、更多药物安全策略等。
- 本项目内容仅供教育与信息参考,不替代专业医疗建议、诊断或治疗。
- 紧急联系人:
- 医疗急救:
120 - 全国心理危机干预热线:
400-161-9995 - 全国统一心理援助热线:
12356
- 医疗急救:
本项目采用 MIT License 开源。请在使用与分发时保留原始版权声明。