diff --git a/docs/my-website/.gitignore b/docs/my-website/.gitignore index 4d860457230..c5090458cda 100644 --- a/docs/my-website/.gitignore +++ b/docs/my-website/.gitignore @@ -19,3 +19,4 @@ npm-debug.log* yarn-debug.log* yarn-error.log* yarn.lock +pnpm-lock.yaml diff --git a/docs/my-website/docs/extras/contributing.md b/docs/my-website/docs/extras/contributing.md index f470515e3f5..64c068a4d3a 100644 --- a/docs/my-website/docs/extras/contributing.md +++ b/docs/my-website/docs/extras/contributing.md @@ -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 + + + + +Installation +``` +npm install --global yarn +``` +Install requirement ``` yarn ``` Run website - ``` yarn start ``` -Open docs here: [http://localhost:3000/](http://localhost:3000/) + + + + +Installation ``` +npm install --global pnpm +``` +Install requirement +``` +pnpm install +``` +Run website +``` +pnpm 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. @@ -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)