Skip to content

Commit

Permalink
Merge readme into one file
Browse files Browse the repository at this point in the history
  • Loading branch information
clementAC committed Oct 22, 2024
1 parent 079eaf3 commit 63c8de1
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 34 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,29 @@

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

Online version of this documentation is available here: https://doc.crowdsec.net/
Online version of this documentation is available here: https://doc.crowdsec.net/

The documentation is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Installation

```console
npm install
```

## Local Development

```console
npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
you can also use the `npm run serve` command to test the build locally.
33 changes: 0 additions & 33 deletions crowdsec-docs/README.md

This file was deleted.

0 comments on commit 63c8de1

Please sign in to comment.