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 198b361 commit 7009d7b
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

## `Carch Official Documentation`

<h4>

This is the official documentation for [Carch](https://github/harilvfs/carch)
</h4>

</div>
<br>
<p align="center">
Expand All @@ -22,26 +27,26 @@

<div align="center">

## πŸ“š Build Documentation
### πŸ“š Build Documentation

</div>


### πŸ› οΈ Clone Repository
#### πŸ› οΈ 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
Expand All @@ -50,7 +55,7 @@ npm run docs:preview

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

### πŸ”„ Development Build
#### πŸ”„ Development Build

*To see live changes while editing the documentation:*

Expand Down

0 comments on commit 7009d7b

Please sign in to comment.