From cc7b06f8e4c8cd223d542baa116e03400edfe041 Mon Sep 17 00:00:00 2001 From: josearangos Date: Sat, 28 Oct 2023 14:25:01 -0500 Subject: [PATCH] refactor Contributing to documentation steps --- docs/my-website/docs/extras/contributing.md | 24 ++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/docs/my-website/docs/extras/contributing.md b/docs/my-website/docs/extras/contributing.md index 6f1e2d01a..f470515e3 100644 --- a/docs/my-website/docs/extras/contributing.md +++ b/docs/my-website/docs/extras/contributing.md @@ -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.