docsify文档项目的运行与部署——以llm-cookbook为例

今天以《面向开发者的 LLM 入门教程，吴恩达大模型系列课程中文版》为例，讲解一下docsify文档项目的运行与部署。

该项目的github地址：https://github.com/datawhalechina/llm-cookbook

一、克隆项目到本地

由于这个项目比较大，直接使用clone命令可能会耗时较久，可以加上--depth 1 进行浅克隆操作，只克隆远程仓库最新的一次提交（commit）及其对应的文件，而不是完整克隆整个仓库的历史记录。

git clone --depth 1 https://github.com/datawhalechina/llm-cookbook.git

二、docsify 的文档网站项目的特点

• 使用 docsify 框架搭建

• 支持 Markdown 渲染

• 支持代码高亮（Python、Bash等）

• 支持数学公式（通过 KaTeX）

• 支持字数统计

• 支持文档分页导航

三、如何在浏览器中运行docsify 项目

方式一：使用 Python 启动本地服务器

# 1. 首先进入 docs 目录
cd docs
# 2. 使用 Python 启动一个简单的 HTTP 服务器
# Python 3.x
python -m http.server 3000
# 或 Python 2.x
python -m SimpleHTTPServer 3000

方式二：使用 docsify-cli 工具（推荐）

# 1. 全局安装 docsify-cli
npm i docsify-cli -g
# 2. 进入项目目录
cd docs
# 3. 启动本地服务器
docsify serve

启动后，打开浏览器访问：

• 方式一：http://localhost:3000

• 方式二：http://localhost:3000（docsify-cli 默认端口也是 3000）

四、部署到debian服务器上

1、确保服务器已经安装了nodejs环境并安装了docsify-cli

# 使用 npm 全局安装 docsify-cli
npm install -g docsify-cli

2、部署项目文件

# 创建项目目录（如果还没有）
mkdir -p /var/www/docs

# 将项目文件复制到服务器
# 假设您使用 scp 或其他方式已经将文件传到服务器上
cp -r /path/to/your/docs/* /var/www/docs/

# 确保创建 .nojekyll 文件（防止 GitHub Pages 忽略下划线开头的文件）
touch /var/www/docs/.nojekyll

3、使用 PM2 管理进程（推荐方式）

# 安装 PM2
npm install -g pm2

# 启动 docsify（使用 PM2 管理）
pm2 start "docsify serve /var/www/docs" --name "docsify-docs"

# 设置开机自启
pm2 startup
pm2 save

4、配置 Nginx 反向代理（推荐配置）

server {
    listen 80;
    server_name your_domain.com;  # 替换为您的域名

    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
} 

PM2常用管理命令

# 查看 PM2 进程状态
pm2 status

# 查看日志
pm2 logs docsify-docs

# 重启服务
pm2 restart docsify-docs

# 停止服务
pm2 stop docsify-docs

# 删除服务
pm2 delete docsify-docs

安全建议：

• 建议配置 SSL 证书，使用 HTTPS

• 配置防火墙，只开放必要端口

• 定期更新系统和依赖包

监控建议：

• 使用 PM2 的监控功能：pm2 monit

• 可以配置 PM2 的日志轮转

• 设置服务器资源监控

如果遇到问题，可以查看以下日志：

# PM2 日志
pm2 logs

# Nginx 错误日志
sudo tail -f /var/log/nginx/error.log

# Nginx 访问日志
sudo tail -f /var/log/nginx/access.log