diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 286341283..753f6e4eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -161,6 +161,26 @@ lucide The lucide.dev website is using [vitepress](https://vitepress.dev/) to generate the static website. The markdown files are located in the docs directory. +#### Running the Docs Website Locally + +To test the docs website locally, follow these steps: +1. **Navigate to the docs directory** + ```sh + cd docs + ``` +2. **Start the Local Development Server** + ```sh + pnpm run docs:dev + ``` +3. **Open the Website Locally** + Vitepress should open with the following format: + + VitePress dev server is running at: + - **Local**: http://localhost:3000/ + - **Network**: http://192.168.x.x:3000/ + + + ### Guides Detailed documentation about: installation, guides, packages, design guides etc.