Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maintenance #640

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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/

clementAC marked this conversation as resolved.
Show resolved Hide resolved
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.

3 changes: 1 addition & 2 deletions crowdsec-docs/blog/2020-08-04-crowdsec_firewall_freebsd.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
slug: crowdsec_firewall_freebsd
title: How to install CrowdSec Firewall Bouncer on FreeBSD
author: Sofian Brabez
author_url: https://github.com/sbz
authors: [sbz]
tags: [bouncer, firewall, crowdsec]
---

Expand Down
3 changes: 1 addition & 2 deletions crowdsec-docs/blog/2021-08-30-metabase_without_docker.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
slug: metabase_without_docker
title: How to configure metabase dasbhoard without docker
author: Crowdsec Team
author_url: https://github.com/crowdsecurity
authors: crowdsec
tags: [dashboard, metabase]
---

Expand Down
3 changes: 1 addition & 2 deletions crowdsec-docs/blog/2024-06-11-cscli_dashboard_deprecation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
slug: cscli_dashboard_deprecation
title: Cscli dashboard deprecation
author: Crowdsec Team
author_url: https://github.com/crowdsecurity
authors: crowdsec
tags: [dashboard, Metabase]
---

Expand Down
8 changes: 8 additions & 0 deletions crowdsec-docs/blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
sbz:
name: Sofian Brabez
url: https://github.com/sbz

crowdsec:
name: Crowdsec Team
url: https://github.com/crowdsecurity
image_url: /img/crowdsec_logo.png
13 changes: 2 additions & 11 deletions crowdsec-docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ const {
ctiApiSidebar,
guidesSideBar,
} = require("./sidebarsUnversioned.js")
const tailwindConfig = require("./tailwind.config.js")

const generateCurrentAndNextRedirects = (s) => [
{
Expand Down Expand Up @@ -303,16 +304,6 @@ module.exports = {
],
},
],
async function myPlugin(context, options) {
return {
name: "docusaurus-tailwindcss",
configurePostCss(postcssOptions) {
// Appends TailwindCSS and AutoPrefixer.
postcssOptions.plugins.push(require("tailwindcss"))
postcssOptions.plugins.push(require("autoprefixer"))
return postcssOptions
},
}
},
"./plugins/tailwind-config.js",
],
}
Loading
Loading