Contributing to Documentation
This website is built using Docusaurus 2, a modern static website generator.
Clone litellm
git clone https://github.com/BerriAI/litellm.git
Local setup for locally running docs​
cd docs/my-website
- Yarn
- pnpm
Installation
npm install --global yarn
Install requirement
yarn
Run website
yarn start
Installation
npm install --global pnpm
Install requirement
pnpm install
Run website
pnpm start
Open docs here: http://localhost:3000/
This command builds your Markdown files into HTML and starts a development server to browse your documentation. Open up http://127.0.0.1:8000/ in your web browser to see your documentation. You can make changes to your Markdown files and your docs will automatically rebuild.
Making changes to Docs​
- All the docs are placed under the
docs
directory - If you are adding a new
.md
file or editing the hierarchy editmkdocs.yml
in the root of the project - After testing your changes, make a change/pull request to the
main
branch of github.com/BerriAI/litellm