https://github.com/autobrr/autobrr.com

Docs for autobrr.
https://github.com/autobrr/autobrr.com

autobrr cross-seed documentation omegabrr

Last synced: 21 days ago
JSON representation

Docs for autobrr.

• Host: GitHub
• URL: https://github.com/autobrr/autobrr.com
• Owner: autobrr
• Created: 2021-12-28T18:30:16.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-05-05T20:41:04.000Z (27 days ago)
• Last Synced: 2025-05-12T04:41:07.261Z (21 days ago)
• Topics: autobrr, cross-seed, documentation, omegabrr
• Language: MDX
• Homepage: https://autobrr.com
• Size: 9.88 MB
• Stars: 2
• Watchers: 2
• Forks: 37
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md

Awesome Lists containing this project

README

        
[![Netlify Status](https://api.netlify.com/api/v1/badges/b6c26aeb-b04d-4cd0-9ddb-62cba5d2fd5c/deploy-status)](https://app.netlify.com/sites/autobrr/deploys)

# Website

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

### Installation

```

$ yarn

```

### Local Development

```

$ yarn 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

```

$ yarn build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```

$ USE_SSH=true yarn deploy

```

Not using SSH:

```

$ GIT_USER= yarn deploy

```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.