wcjiang/reference

Reference Docker 镜像文档

镜像概述和主要用途

Reference 是一个为开发人员提供快速参考备忘清单（速查表）的 Docker 镜像。该镜像可部署为 Web 应用，提供各种技术栈的简洁参考资料，方便开发人员日常工作中快速查阅。这是英文版 https://github.com/Randy8080/reference 的中文增强版本，内容更丰富，专为中文用户优化。

官网: https://jaywcjlove.github.io/reference
GitHub: https://github.com/jaywcjlove/reference

!Quick Reference

核心功能和特性

• 丰富的技术速查表：涵盖多种编程语言、框架、工具的参考资料
• 简洁易用界面：直观的分类和搜索功能，快速定位所需内容
• 轻量级部署：通过 Docker 容器化部署，配置简单，资源占用低
• 国内访问优化：提供多个国内镜像网站，解决访问困难问题
• 社区驱动更新：支持用户贡献和请求添加新的备忘清单

使用场景和适用范围

• 日常开发参考：开发过程中快速查阅语法、命令和API
• 学习辅助工具：学习新技术时提供便捷的参考资料
• 团队知识库：部署在内部服务器，作为团队共享的技术参考资源
• 教学辅助材料：培训或教学环境中提供标准化的技术参考

使用方法和配置说明

前提条件

• Docker 引擎 (1.13.0 或更高版本)
• 网络连接（用于拉取镜像）

获取镜像

bash
docker pull wcjiang/reference

基本部署

使用以下命令启动容器：

bash
docker run --name reference -d -p 9667:3000 wcjiang/reference:latest

参数说明：

• --name reference: 指定容器名称为 "reference"
• -d: 后台运行容器
• -p 9667:3000: 端口映射，将容器的 3000 端口映射到主机的 9667 端口

启动后，在浏览器中访问以下 URL 即可使用：

http://localhost:9667/

Docker Compose 部署

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  reference:
    image: wcjiang/reference:latest
    container_name: reference
    ports:
      - "9667:3000"
    restart: unless-stopped

使用以下命令启动：

bash
docker-compose up -d

国内镜像网站

由于国内网络访问限制，可使用以下国内镜像网站：

• quickref.cn
• 78888889.xyz
• pusukeji.com
• magese.com
• doraemon.press
• foreverlink.love
• xod.cc (每天自动同步)
• jhao.me
• maoo.me (每天自动同步)

注：更多国内镜像可参考项目 GitHub 页面

参与贡献

提交新的备忘清单

如果您有备忘清单要分享，请参考 https://github.com/jaywcjlove/reference/blob/main/CONTRIBUTING.md%E3%80%82

请求添加备忘清单

如果您希望添加特定内容的备忘清单，可以 https://github.com/jaywcjlove/reference/issues/new?template=cheatsheet-request.yml%E3%80%82

许可证

本项目采用 MIT 许可证 - 详情参见 https://github.com/jaywcjlove/reference/blob/main/LICENSE 文件。

MIT © https://github.com/jaywcjlove