seerr/gen-docs
Fallenbagel df2f05f129
docs(readme): fix issues in readme, contributing guide (#854)
* docs(readme): fix formatting in the getting started section

* docs: proper contributing instructions & fix docs website url
2024-06-30 05:48:42 +05:00
..
src docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
static docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
.gitignore docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
babel.config.js docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
docusaurus.config.ts ci: attempt to fix docs deployment 2024-06-30 05:06:59 +05:00
package.json docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
pnpm-lock.yaml docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
README.md docs(readme): fix issues in readme, contributing guide (#854) 2024-06-30 05:48:42 +05:00
sidebars.ts docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
tailwind.config.js docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
tsconfig.json docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00

Jellyseerr Documentation

Jellyseerr docs is built using Docusaurus, a modern static website generator.

Jellyseerr docs will be available at 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.