文档贡献指南
本网站使用 Docusaurus 2 构建,这是一个现代化的静态网站生成器。
克隆 litellm 项目
git clone https://github.com/BerriAI/litellm.git
本地运行文档的本地设置
安装
npm install --global yarn
本地开发
cd docs/my-website
安装依赖
yarn
运行网站
yarn start
此命令会将您的 Markdown 文件构建为 HTML,并启动一个开发服务器以浏览您的文档。在您的网络浏览器中打开 [http://127.0.0.1:8000/](http://127.0.0.1:8000/) 以查看您的文档。您可以对 Markdown 文件进行更改,文档将自动重新构建。
[完整教程在此](https://docs.readthedocs.io/en/stable/intro/getting-started-with-mkdocs.html)
### 修改文档
- 所有文档都放置在 `docs` 目录下
- 如果您添加新的 `.md` 文件或编辑层次结构,请编辑项目根目录中的 `mkdocs.yml`
- 在测试您的更改后,对 [github.com/BerriAI/litellm](https://github.com/BerriAI/litellm) 的 `main` 分支进行更改