phoenix/litellm-mirror
0
0
Fork 1
mirror of https://github.com/BerriAI/litellm.git synced 2025-04-24 18:24:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor Contributing to documentation steps

Browse source
This commit is contained in:
josearangos 2023-10-28 14:25:01 -05:00
parent 347a5c46e2
commit cc7b06f8e4
1 changed files with 19 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/my-website/docs/extras/contributing.md
View file

@ -1,5 +1,7 @@
# Contributing to Documentation
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
Clone litellm
```
git clone https://github.com/BerriAI/litellm.git
@ -9,16 +11,28 @@ git clone https://github.com/BerriAI/litellm.git
#### Installation
```
pip install mkdocs
npm install --global yarn
```
#### Locally Serving Docs
### Local Development
```
mkdocs serve
cd docs/my-website
```
If you see `command not found: mkdocs` try running the following
Let's Install requirement
```
python3 -m mkdocs serve
yarn
```
Run website
```
yarn start
```
Open docs here: [http://localhost:3000/](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/](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.