mirror of
https://github.com/sct/overseerr.git
synced 2025-12-26 16:27:17 +01:00
df2f05f129
* docs(readme): fix formatting in the getting started section * docs: proper contributing instructions & fix docs website url
28 lines
610 B
Markdown
28 lines
610 B
Markdown
# Jellyseerr Documentation
|
|
|
|
Jellyseerr docs is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
|
|
|
|
Jellyseerr docs will be available at [docs.jellyseerr.dev](https://docs.jellyseerr.dev).
|
|
|
|
### Installation
|
|
|
|
```
|
|
$ pnpm
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```
|
|
$ pnpm 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
|
|
|
|
```
|
|
$ pnpm build
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|