5分钟上手 Prompt Engineering Guide:新手本地跑通 LLM 提示词文档站
【免费下载链接】Prompt-Engineering-Guide🐙 Guides, papers, lessons, notebooks and resources for prompt engineering, context engineering, RAG, and AI Agents.项目地址: https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide
Prompt Engineering Guide 是一个开源的提示工程(Prompt Engineering)资源库,覆盖 LLM 提示技巧、RAG 与 AI Agents,收录了论文、教程、讲义和可运行 Notebook。如果你第一次接触这个项目,记住两个收获:5 分钟内可以在本地跑起这个多语言文档站,遇到卡点时知道去哪儿查。下面是完整的新手实操路线。
先说结论:这个仓库能帮你拿到什么
- 学习资料:13 种语言的文档,覆盖零样本、少样本、思维链等技巧,源码在 pages/ 目录
- 实践样例:notebooks/ 里是可执行的 RAG、函数调用、ReAct 等示例
- 讲义与速查:lecture/ 提供课程幻灯片,guides/ 是快速上手指南
只在线阅读当然可以,但克隆到本地更实用——你可以预览翻译效果、修改内容并验证改动。
第一次使用:从克隆到本地预览
按 4 步走,就能看到站点跑起来:
- 确认环境:需要 Node.js 18 及以上版本和 pnpm 包管理器
- 克隆仓库:
git clone https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide- 进入项目目录安装依赖:
pnpm install - 启动开发服务器:
pnpm dev,然后浏览器打开http://localhost:3000/
此时你应该能看到带侧边栏目录的文档站。点开 Introduction、Techniques 等章节翻一遍,确认站点正常。
新手容易卡住的 3 个位置
依赖安装报错
现象:pnpm install卡住或直接报 Node 版本错误。原因:Node 版本低于 18,或网络源不通。处理动作:把 Node 升到 18 以上,或改用可用的 npm 镜像源后重新安装。验证方式:node -v和pnpm -v能输出正常版本号,依赖安装完成无红色报错。
端口 3000 被占用
现象:终端提示端口已使用,浏览器打不开页面。原因:本机其他服务占用了 3000 端口。处理动作:先关闭其他占用服务,仍不行就用lsof -i :3000找到对应进程再停掉。验证方式:终端出现 ready 提示,浏览器能正常加载首页。
改了内容却不生效
现象:修改了 mdx 文件,浏览器页面却没变化。原因:同一个页面存在多个语言文件,比如.en.mdx、.zh.mdx,你改的可能不是当前查看的那个。处理动作:对照浏览器地址栏的语言后缀,确认编辑的是对应语言的文件。验证方式:保存后开发服务器会自动热更新,刷新即可看到新内容。
想贡献?先做 3 个安全动作
在动手改代码前,先养成这些习惯,避免把主分支搞乱:
- 任何修改前先拉新分支,保持主分支干净
- 改动后先用
pnpm dev本地确认效果符合预期,再考虑推送 - 提交 Issue 或 PR 前,写清系统环境、复现步骤和完整报错,方便维护者快速定位
仓库内没有单独的贡献说明文件,具体规范以最新的 README.md 和现有 Issue 讨论为准。
从哪一页读起:资源导航
- 提示词零基础:从 pages/introduction/ 的入门章节开始
- 想系统学技巧:看 pages/techniques/ 下的技巧章节
- 想直接跑代码:浏览 notebooks/ 里的示例
- 想做多语言翻译:先看各目录下的
_meta.*.json,理解页面组织结构
完成以上动作后,你就可以在本地预览站点、修改内容并验证效果,用一个小的文档改动开启自己的第一次贡献。
【免费下载链接】Prompt-Engineering-Guide🐙 Guides, papers, lessons, notebooks and resources for prompt engineering, context engineering, RAG, and AI Agents.项目地址: https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考