From 80a4c03df3cd5fc15993770ba5af1c532736c9a3 Mon Sep 17 00:00:00 2001 From: Hari Chalise Date: Mon, 9 Dec 2024 23:11:52 +0545 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 70f3c03..c89e497 100644 --- a/README.md +++ b/README.md @@ -16,40 +16,47 @@ [![github actions build status][check]][link] +
-## `Build` +## Build Documentation
-### Clone +--- + +### Clone Repository ```sh git clone https://github.com/carch-org/docs cd docs ``` -## Build +### Build +*To generate the static documentation files:* ```sh npm run docs:build ``` -## Preview +### Preview +*To preview the generated build locally:* ```sh npm run docs:preview ``` -*Then copy the local ip and paste in broswer to see the build* +*Copy the local IP address provided and paste it into your browser to view the documentation.* -## Dev Build +### Development Build + +*To see live changes while editing the documentation:* ```sh npm run docs:dev ``` -*You can see the changes at real time you changes something on docs* + [check]: https://github.com/carch-org/docs/actions/workflows/docs.yml/badge.svg [link]: https://github.com/carch-org/docs/actions/workflows/docs.yml