Skip to content

Commit 642774d

Browse files
committed
Merge readme into one file
1 parent 81bebfb commit 642774d

File tree

2 files changed

+26
-34
lines changed

2 files changed

+26
-34
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,29 @@
22

33
This repository holds the documentation for the [crowdsec project](https://github.com/crowdsecurity/crowdsec).
44

5-
Online version of this documentation is available here: https://doc.crowdsec.net/
5+
Online version of this documentation is available here: https://doc.crowdsec.net/
6+
7+
The documentation is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
8+
9+
## Installation
10+
11+
```console
12+
npm install
13+
```
14+
15+
## Local Development
16+
17+
```console
18+
npm run start
19+
```
20+
21+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
22+
23+
## Build
24+
25+
```console
26+
npm run build
27+
```
28+
29+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
30+
you can also use the `npm run serve` command to test the build locally.

crowdsec-docs/README.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)