diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 19177a3..8926812 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,9 +19,12 @@ jobs: # Get current year YEAR=$(date +'%Y') + # Convert username to lowercase + USERNAME=$(echo "${{ github.repository_owner }}" | tr '[:upper:]' '[:lower:]') + # Process the entire mkdocs.yml file cat mkdocs.yml | \ - sed "s/{{ username }}/${{ github.repository_owner }}/g" | \ + sed "s/{{ username }}/${USERNAME}/g" | \ sed "s/{{ repo_name }}/${{ github.event.repository.name }}/g" | \ sed "s/{{ year }}/${YEAR}/g" \ > mkdocs.generated.yml diff --git a/README.md b/README.md index 20300e9..1cba24f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,48 @@ -# Plex Guide Template +# Plex Documentation Guide -Built with Material for MKDocs, deployed and hosted via Github Pages. TODO: Fill out README with links to useful videos, add links to MKDocs plugins, other misc things -
+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. -https://squidfunk.github.io/mkdocs-material/publishing-your-site/#github-pages +## 🚀 Getting Started + +1. Fork this repository to your own GitHub account +2. Configure GitHub Pages: + - Go to Settings > Pages + - Set "Source" to "Deploy from a branch" + - Select "gh-pages" branch and "/" (root) folder + - Click Save + +Your site will be available at `https://yourusername.github.io/mkdocs-plex-guide-template` + +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 + +## 📝 Customization + +### Basic Configuration +The following values are automatically set via environment variables: +- `username` - Your GitHub username (lowercase) +- `repo_name` - Repository name +- `year` - Current year + +### Content Customization +Key files to modify: +- `docs/*.md` - Documentation pages +- `docs/stylesheets/extra.css` - [Custom admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#custom-admonitions) +- `docs/assets/images/` - Images and video + +### Default Values +You can customize default values for: +- Request URL: `request.example.com` +- Domain name: `example.com` + +Edit these in [`main.py`](main.py) in the project root. These values are used throughout the rendered markdown pages. + +## 📚 Resources + +### Documentation +- [Material for MkDocs Customization](https://squidfunk.github.io/mkdocs-material/customization/) +- [Publishing Your Site](https://squidfunk.github.io/mkdocs-material/publishing-your-site/#github-pages) +- [MkDocs Plugins Catalog](https://github.com/mkdocs/catalog) + +### Video Tutorials +- [Creating Documentation with MkDocs Material Theme](https://www.youtube.com/watch?v=Q-YA_dA8C20) - James Willett +- [Hosting MkDocs on Cloudflare Pages](https://www.youtube.com/watch?v=7-HhLascLuM) - Techdox