Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
harilvfs authored Dec 9, 2024
1 parent d39f8c9 commit 683a896
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,45 +30,63 @@ This is the official documentation for [Carch Project](https://github.com/harilv

### πŸ“š Build Documentation

</div>

<div align="center">

#### πŸ› οΈ Clone Repository

</div>

```sh
git clone https://github.com/carch-org/docs
cd docs
```

<br>

<div align="center">

#### πŸ—οΈ Build
*To generate the static documentation files:*

</div>

```sh
npm run docs:build
```

<br>

<div align="center">

#### πŸ‘€ Preview
*To preview the generated build locally:*

</div>

```sh
npm run docs:preview
```

<div align="center">

*Copy the local IP address provided and paste it into your browser to view the documentation.*

</div>

<br>

<div align="center">

#### πŸ”„ Development Build

*To see live changes while editing the documentation:*

</div>

```sh
npm run docs:dev
```

</div>

[check]: https://github.com/carch-org/docs/actions/workflows/docs.yml/badge.svg
[link]: https://github.com/carch-org/docs/actions/workflows/docs.yml

0 comments on commit 683a896

Please sign in to comment.