Skip to content

Commit c3d9ea0

Browse files
committed
Added README which contains link to website and steps for running locally
1 parent dc4c1ee commit c3d9ea0

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## CodeSnap Documentation Site
2+
3+
Welcome! This repo contains the documentation site for CodeSnap.
4+
5+
It can be viewed [here](https://codesnap-rs.github.io/docs/).
6+
7+
It is built using Vitepress
8+
9+
## Adding updates
10+
To get started, just clone the repo:
11+
```bash
12+
git clone https://github.com/codesnap-rs/docs
13+
cd docs
14+
```
15+
16+
Then install the dependencies:
17+
```bash
18+
npm install
19+
```
20+
21+
To run the dev server:
22+
```bash
23+
npm run docs:dev
24+
```
25+
26+
To build the site:
27+
```bash
28+
npm run docs:build
29+
```

0 commit comments

Comments
 (0)