An open API service indexing awesome lists of open source software.

https://github.com/detain/phlix-docs

Phlix Media Server documentation — end-user, developer, and hub-admin guides
https://github.com/detain/phlix-docs

documentation media-server phlix plex-alternative self-hosted

Last synced: 5 days ago
JSON representation

Phlix Media Server documentation — end-user, developer, and hub-admin guides

Awesome Lists containing this project

README

          

# Phlix Documentation

[![Deploy Docs](https://github.com/detain/phlix-docs/actions/workflows/docs.yml/badge.svg)](https://github.com/detain/phlix-docs/actions/workflows/docs.yml)

Phlix Media Server documentation — end-user guides, developer docs, and hub-admin references.

## Live Site

Visit the published docs at: **https://detain.github.io/phlix-docs** (GitHub Pages)

## Local Development

```bash
npm install
npm run docs:dev
```

Then open http://localhost:5173

## Building

```bash
npm run docs:build # builds to docs/.vitepress/dist
npm run docs:preview # preview the built site
```

## Contributing

Doc PRs are welcome! Please keep changes focused on the markdown content in `docs/`.

For developer docs, see the [Developer Documentation](https://detain.github.io/phlix-docs/dev/architecture-server).
For hub admin guides, see the [Hub Admin Documentation](https://detain.github.io/phlix-docs/hub-admin/install).