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.

• 📚 Pre-built pages for common Plex topics
• 🔄 Automatic deployment via GitHub Actions
• 🎨 Material for MkDocs theme with custom styling
• 🔧 Easy configuration through environment variables

1. Fork this repository to your own GitHub account

2. Enable GitHub Pages:

   • Go to Settings > Pages
   • Under "Build and deployment", change Source to "GitHub Actions"
   • Wait for the blue success message "GitHub Pages source saved"

3. Enable GitHub Actions:

   • Go to Actions tab
   • 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 Build and Deploy MkDocs Site in the Actions tab
     • 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/mkdocs-plex-guide-template

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

Variables are defined in the extra: section of mkdocs.yml and can be used throughout your markdown pages. For repository variables like username and repo_name, we use GitHub's built-in environment variables. For custom variables, we use plaintext values:

extra:
  vars:
    # GitHub environment variables
    username: !ENV GITHUB_REPOSITORY_OWNER
    repo_name: !ENV GITHUB_REPOSITORY
    # Custom plaintext values
    request_url: "request.example.com"
    plex_url: "plex.example.com"
    plex_libraries: "Movies and TV Shows"
    noreply_email: "noreply@example.com"

You can reference these variables in your markdown files using the syntax {{ vars.variable_name }}.

Key files to modify:

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

If your deployment fails, check:

1. GitHub Pages is enabled and set to "GitHub Actions" as the source
2. GitHub Actions is enabled for your repository

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

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