mirror of
https://github.com/BerriAI/litellm.git
synced 2026-10-07 02:59:05 +00:00
Update contributing-to-documentation documentation to include pnpm guide (#10523)
This commit is contained in:
parent
1969e351fe
commit
2138170861
2 changed files with 36 additions and 16 deletions
1
docs/my-website/.gitignore
vendored
1
docs/my-website/.gitignore
vendored
|
|
@ -19,3 +19,4 @@ npm-debug.log*
|
|||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
yarn.lock
|
||||
pnpm-lock.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,6 @@
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Contributing to Documentation
|
||||
|
||||
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
||||
|
|
@ -9,31 +12,51 @@ git clone https://github.com/BerriAI/litellm.git
|
|||
|
||||
### Local setup for locally running docs
|
||||
|
||||
#### Installation
|
||||
```
|
||||
npm install --global yarn
|
||||
```
|
||||
|
||||
|
||||
### Local Development
|
||||
|
||||
```
|
||||
cd docs/my-website
|
||||
```
|
||||
|
||||
Let's Install requirement
|
||||
|
||||
<Tabs>
|
||||
|
||||
<TabItem value="yarn" label="Yarn">
|
||||
|
||||
Installation
|
||||
```
|
||||
npm install --global yarn
|
||||
```
|
||||
Install requirement
|
||||
```
|
||||
yarn
|
||||
```
|
||||
Run website
|
||||
|
||||
```
|
||||
yarn start
|
||||
```
|
||||
Open docs here: [http://localhost:3000/](http://localhost:3000/)
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="pnpm" label="pnpm">
|
||||
|
||||
Installation
|
||||
```
|
||||
npm install --global pnpm
|
||||
```
|
||||
Install requirement
|
||||
```
|
||||
pnpm install
|
||||
```
|
||||
Run website
|
||||
```
|
||||
pnpm start
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -42,8 +65,4 @@ This command builds your Markdown files into HTML and starts a development serve
|
|||
### 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 edit `mkdocs.yml` in the root of the project
|
||||
- After testing your changes, make a change to the `main` branch of [github.com/BerriAI/litellm](https://github.com/BerriAI/litellm)
|
||||
|
||||
|
||||
|
||||
|
||||
- After testing your changes, make a change/pull request to the `main` branch of [github.com/BerriAI/litellm](https://github.com/BerriAI/litellm)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue