nokidev / jellyfin-docs

Documentation for Jellyfin

Jellyfin Documentation

Part of the Jellyfin Project

This repository houses all documentation for Jellyfin available at jellyfin.org and written in markdown.

Layout

This repository is built using DocFX using DocFX Flavored Markdown, for bit of a tutorial on writing, see the Content section here.

Plugin API

Describe all available API surfaces and class from plugin development.

ApiSpec

apispec is used to overwrite specific plugin API page contexts.

Docs

docs is the main custom documentation directory. All uids for the custom documentation are relative to this directory, with administration and contributing shortened to admin and contrib respectively. So for example to reference the file general/administration/installing.md one would use xref:admin-installing with an optional anchor like xref:admin-installing#arch.

Administration

Should be used for documentation related to advanced server setup including non-default configs for more advanced users.

Contributing

Should be used for documentation related to development, translations, releases, and other ways to contribute to the project.

Clients

Any documentation related to the clients.

Server

Any documentation related to managing the server or explaining certain features.

Media

Naming conventions for all supported media types, such as movies or podcasts.

Plugin

Any plugins documentation.