From 03ccb4fb59d2d476cc61bdc96aadd308d200ec7a Mon Sep 17 00:00:00 2001 From: Hari Chalise Date: Mon, 9 Dec 2024 23:04:41 +0545 Subject: [PATCH] Update README.md --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 6d062b7..c74781d 100644 --- a/README.md +++ b/README.md @@ -17,5 +17,34 @@ +## Build + +```sh +git clone https://github.com/carch-org/docs +cd docs +``` + +## Npm + +```sh +npm run docs:build +``` + +## Preview + +```sh +npm run docs:preview +``` + +*Then copy the local ip and paste in broswer to see the build* + +## Dev Build + +```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