diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 753f6e4eb..898485681 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -164,22 +164,26 @@ The lucide.dev website is using [vitepress](https://vitepress.dev/) to generate #### Running the Docs Website Locally To test the docs website locally, follow these steps: + 1. **Navigate to the docs directory** - ```sh - cd docs - ``` + +```sh +cd docs +``` + 2. **Start the Local Development Server** - ```sh - pnpm run docs:dev - ``` + +```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/ +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 @@ -193,8 +197,6 @@ All the icons of lucide in SVG format. These will be used as source for all the Includes all the (npm) packages of lucide. -> Note: One package is not managed by pnpm: **lucide-flutter**, this package is written in Dart and uses pub for publishing. - ### Scripts Includes useful scripts to automate certain jobs. Big part of the scripts is the template generation, for example it generates icon components for all the packages. These scripts are usually executed from the "scripts" section in the package.json.