Skip to main content

文档

如何在网站上呈现笔记本​

请参阅此处以获取有关如何在notebook目录中呈现笔记本的说明。

本地构建文档​

1. 要在本地构建和测试文档，请先安装Node.js。例如，

nvm install --lts

然后，安装yarn和其他所需的软件包：

npm install --global yarn
pip install pydoc-markdown pyyaml termcolor

2. 您还需要安装quarto。请从此网站点击Pre-release标签下载最新版本的quarto并安装。确保quarto版本为1.5.23或更高。

3. 最后，运行以下命令进行构建：

cd website
yarn install --frozen-lockfile --ignore-engines
pydoc-markdown
python process_notebooks.py render
yarn start

最后一个命令会启动一个本地开发服务器并打开一个浏览器窗口。 大多数更改都会实时反映，无需重新启动服务器。

使用Docker构建​

要在Docker容器中构建和测试文档，请使用dev文件夹中的Dockerfile按上述说明构建您的镜像：

docker build -f .devcontainer/dev/Dockerfile -t autogen_dev_img https://github.com/microsoft/autogen.git#main

然后像这样启动容器，这将登录并确保Docker端口3000映射到本地机器上的端口8081：

docker run -it -p 8081:3000 -v `pwd`/autogen-newcode:newstuff/ autogen_dev_img bash

在Docker的CLI中运行以下命令：

cd website
yarn install --frozen-lockfile --ignore-engines
pydoc-markdown
python process_notebooks.py render
yarn start --host 0.0.0.0 --port 3000

完成后，您应该能够在http://127.0.0.1:8081/autogen访问文档。