From 683a896e287f119499e14f1e95f2a3efbf3ff3cf Mon Sep 17 00:00:00 2001 From: Hari Chalise Date: Mon, 9 Dec 2024 23:28:26 +0545 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d4fedbf..4510e57 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,14 @@ This is the official documentation for [Carch Project](https://github.com/harilv ### 📚 Build Documentation + + +
#### 🛠️ Clone Repository +
+ ```sh git clone https://github.com/carch-org/docs cd docs @@ -40,35 +45,48 @@ cd docs
+
+ #### 🏗️ Build *To generate the static documentation files:* +
+ ```sh npm run docs:build ```
+
+ #### 👀 Preview *To preview the generated build locally:* +
+ ```sh npm run docs:preview ``` - +
+ *Copy the local IP address provided and paste it into your browser to view the documentation.* +
+
+
+ #### 🔄 Development Build *To see live changes while editing the documentation:* +
+ ```sh npm run docs:dev ``` - - [check]: https://github.com/carch-org/docs/actions/workflows/docs.yml/badge.svg [link]: https://github.com/carch-org/docs/actions/workflows/docs.yml