Skip to content

Commit

Permalink
Test macros
Browse files Browse the repository at this point in the history
  • Loading branch information
MisterCalvin committed Feb 16, 2025
1 parent 41632f7 commit 56276ed
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 19 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Plex Guide Template

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
<br>

https://squidfunk.github.io/mkdocs-material/publishing-your-site/#github-pages
2 changes: 1 addition & 1 deletion docs/pinning-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

After accepting your invitation to my Plex server, you'll need to pin my shared libraries to your sidebar. This is a required step - without it, you might only see Plex's default content instead of my media collection. Here's what you need to know:

1. Look for "<REPLACE_ME>'s Plex" in your media sources
1. Look for "{{ meta.username }}'s Plex" in your media sources
2. You'll see two libraries: Movies and TV Shows
3. Pin both of these libraries to your sidebar

Expand Down
6 changes: 3 additions & 3 deletions docs/requesting-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

You can request new Movies or TV Shows in two ways:

1. Visit [request.mydomain.com](https://request.mydomain.com) to make direct requests. These are typically approved within 10-15 minutes, and if the content has been released digitally, it will be ready to stream on Plex within 10 minutes.
1. Visit [{{ config.extra.site.request_url }}](https://{{ config.extra.site.request_url }}) to make direct requests. These are typically approved within 10-15 minutes, and if the content has been released digitally, it will be ready to stream on Plex within 10 minutes.
2. Add content to your Plex Universal Watchlist, and it will be automatically requested for you.

!!! important
For the auto-request feature to work with your Watchlist, you must log into request.mydomain.com at least once every 90 days. If you don't log in regularly, the system won't be able to see your Watchlist, and I won't know what content you're waiting for.
For the auto-request feature to work with your Watchlist, you must log into {{ config.extra.site.request_url }} at least once every 90 days. If you don't log in regularly, the system won't be able to see your Watchlist, and I won't know what content you're waiting for.

## Additional Information
For more details about requesting content, check out these FAQ pages:

- [Responsible Content Requesting](faq/responsible-content-requests.md) - Understanding how the server works and best practices when requesting content
- [I requested something an hour ago but it hasn't shown up yet. Why?](faq/missing-requests.md) - Release dates and availability within request.mydomain.com
- [I requested something an hour ago but it hasn't shown up yet. Why?](faq/missing-requests.md) - Release dates and availability within {{ config.extra.site.request_url }}
- [I'm having a problem with a Movie or TV Show](faq/content-issues.md) - Reporting issues with Movies or TV Shows
- [Content Quality and Language Options](faq/special-requests.md) - Media quality defaults, language tracks, and special content requests
- [I don't want to use this request thingy, can't I just text you what I want?](faq/i-dont-want-to-use-overseerr.md) - Why we use a request system
23 changes: 14 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
site_name: "{{ meta.username }}.github.io"
site_url: "https://{{ meta.username }}.github.io"
site_name: "{{ config.extra.site.username }}.github.io"
site_url: "https://{{ config.extra.site.username }}.github.io"
theme:
name: material
logo: assets/images/plex-logo.webp
Expand Down Expand Up @@ -57,7 +57,7 @@ nav:
- I requested something an hour ago but it hasn't shown up yet. Why?: faq/missing-requests.md
- I'm having a problem with a Movie or TV Show: faq/content-issues.md
- Content Quality and Language Options: faq/special-requests.md
- I don't want to use this request thingy, can't I just text you what I want?: faq/i-dont-want-to-use-overseerr.md
- I don't want to use this request thingy, can't I just tell you what I want?: faq/i-dont-want-to-use-overseerr.md
- Missing Confirmation Emails: faq/missing-emails.md
- Can I share your Plex server with someone else?: faq/can-i-share-your-plex.md
- Plex is awesome! Can I send you some money to support it?: faq/how-can-i-support-you.md
Expand All @@ -69,9 +69,9 @@ plugins:
- mkdocs-video
- git-revision-date-localized
- git-committers:
repository: "{{ meta.full_repo }}"
repository: !ENV [GITHUB_REPOSITORY, "your-username/your-repo"]
branch: main
- replace
- macros

markdown_extensions:
- toc:
Expand All @@ -93,19 +93,24 @@ markdown_extensions:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

copyright: "Copyright &copy; {{ meta.year }} {{ meta.username }}"
copyright: "Copyright &copy; {{ page.meta.git_creation_date_localized.year }} {{ config.extra.site.username }}"

extra_css:
- stylesheets/extra.css

extra:
social:
- icon: fontawesome/brands/github
link: "https://github.com/{{ meta.username }}"
name: "{{ meta.username }} @ Github"
link: "https://github.com/{{ config.extra.site.username }}"
name: "{{ config.extra.site.username }} @ Github"
- icon: fontawesome/brands/discord
link: https://discord.com
name: Discord Channel
- icon: fontawesome/solid/globe
link: "https://{{ meta.username }}.github.io"
link: "https://{{ config.extra.site.username }}.github.io"
name: Personal Website
site:
username: !ENV [GITHUB_REPOSITORY_OWNER, "Ghost"]
repo_name: !ENV [GITHUB_REPOSITORY_NAME, "mkdocs-plex-guide-template"]
domain: "example.com"
request_url: "request.example.com"
5 changes: 0 additions & 5 deletions replacements.yml

This file was deleted.

2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ regex>=2022.4
requests~=2.26
mkdocs-git-revision-date-localized-plugin
mkdocs-git-committers-plugin-2~=2.5.0
git+https://github.com/SivagiriVisakan/mkdocs-replace-plugin.git
mkdocs-macros-plugin

0 comments on commit 56276ed

Please sign in to comment.