Plex Documentation Guide

A standardized documentation template for your Plex server, built with Material for MkDocs and deployed via GitHub Pages. This template includes pre-built pages covering common Plex topics like streaming quality, content requests, transcoding, and more.

🚀 Getting Started

Important

Complete all steps below to ensure your site deploys correctly. Missing any step will cause the deployment to fail.

1. Fork this repository to your own GitHub account

2. Enable GitHub Pages:

   • Go to Settings > Pages
   • Under "Build and deployment", set Source to "GitHub Actions"
   • Click Save

3. Enable GitHub Actions:

   • Go to Actions tab (top of this page)
   • Click "I understand my workflows, go ahead and enable them"

4. Run the workflow:

   • Option 1: Modify and push a change (e.g., customize variables in main.py)
   • Option 2: Manually trigger the workflow
     • Go to Actions tab
     • Select "Build and Deploy MkDocs Site" workflow from the left sidebar
     • Click "Run workflow" dropdown button
     • Select branch (main) and click "Run workflow"

Your site will be available at https://yourusername.github.io/mkdocs-plex-guide-template after the workflow completes.

The template will automatically use your GitHub username and repository name throughout the site. You can see this in action at my demo site: https://mistercalvin.github.io/

Automatic Deployment

The site is automatically built using GitHub Actions whenever changes are pushed to the main branch. After a successful build, the site is deployed to the gh-pages branch, which GitHub Pages then serves automatically. You can monitor the build and deployment process in the Actions tab of your repository.

📝 Customization

Basic Configuration

The following values are automatically set via environment variables in ci.yml and used in the header + footer of your MKDocs site:

• username - Your GitHub username (lowercase)
• repo_name - Repository name
• year - Current year

Default Values

The following values can be set in main.py or in Settings (top of this page) > Security > Secrets and variables > Actions > Variables tab. These values are used throughout the rendered site pages:

• request_url: request.example.com
• plex_url: plex.example.com
• plex_libraries: Movies and TV Shows
• noreply_email: noreply@example.com

Content Customization

Key files to modify:

• docs/*.md - Documentation pages
• docs/stylesheets/extra.css - Custom admonitions
• docs/assets/ - Images and video

📚 Resources

Documentation / Plugins

• Material for MkDocs - Getting started
• MkDocs Plugins Catalog
• MKDocs Pasword Encryption Plugin

Video Tutorials

• Creating Documentation with MkDocs Material Theme - James Willett
• Hosting MkDocs on Cloudflare Pages - Techdox