Remove markdown-callouts and make use of Material's admonitions instead

README.md

@@ -11,12 +11,12 @@ To setup a local development server:
 
 Install mkdocs with pip:
 ```
-pip3 install mkdocs markdown-callouts mkdocs-material
+pip3 install mkdocs mkdocs-material
 ```
 
 From the AUR:
 ```
-yay -S mkdocs markdown-callouts mkdocs-material
+yay -S mkdocs mkdocs-material
 ```
 
 More details: [User Guide](https://www.mkdocs.org/user-guide/installation/)

mkdocs/docs/Installation.md

@@ -1,6 +1,7 @@
 # Detailed Installation Instructions
 
-NOTE: To install Tube Archivist using Docker, the default method, please see the [project README for instructions](https://github.com/tubearchivist/tubearchivist#installing-and-updating).
+!!! note
+    To install Tube Archivist using Docker, the default method, please see the [project README for instructions](https://github.com/tubearchivist/tubearchivist#installing-and-updating).
 
 ---
 
@@ -235,8 +236,9 @@ Once all of the folders have been created, it should have a folder structure wit
         - `xpack.security.enabled=true`
         - `ELASTIC_PASSWORD=verysecret` 
         - `path.repo=/usr/share/elasticsearch/data/snapshot`
-          > NOTE: Do not use the default password as it is very insecure.
-          > Activating snapshots for backups should only be done *after* setting the `path.repo` setting.
+          > !!! note "BE AWARE"
+                - Do not use the default password as it is very insecure.
+                - Activating snapshots for backups should only be done *after* setting the `path.repo` setting.
         ![Synology - ElasticSearch Environment Configurations](assets/Synology_0.2.0_Docker-ES-Env-Conf.png)
     12. Click on the **Apply** button.
     13. Back on the **Create Container** screen, click the **Next** button.
@@ -281,15 +283,17 @@ Once all of the folders have been created, it should have a folder structure wit
       - `TA_PASSWORD=verysecret`
       - `ELASTIC_PASSWORD=verysecret`
       - `TZ=America/New_York`
-      > NOTE: Do not use the default password as it is very insecure.
-      > Ensure that ELASTIC_PASSWORD matches the password used on the tubearchivist-es container.
+      > !!! note "BE AWARE"
+            - Do not use the default password as it is very insecure.
+            - Ensure that ELASTIC_PASSWORD matches the password used on the tubearchivist-es container.
       ![Synology - TubeArchivist Environment Configurations](assets/Synology_0.2.0_Docker-TA-Env-Conf.png)
    13. Click on the **Apply** button.
    14. Back on the **Create Container** screen, click the **Next** button.
    15. Review the settings to confirm, then click the **Apply** button.
 6. After the containers have been configured and started, you can go to the **Container** tab and monitor the containers.
 7. To review the logs to ensure that the system has started successfully, select the "tubearchivist" container and click on the **Details** button. In the new window, go to the **Log** tab. Monitor the logs until either an error occurs or the message `celery@tubearchivist ready.` is in the logs. This may take a few minutes, especially for a first time setup.
-   > Note: Synology Docker presents the logs in a pagination format. If you are not seeing the logs update, check if there are additional pages.
+   > !!! note
+         Synology Docker presents the logs in a pagination format. If you are not seeing the logs update, check if there are additional pages.
 8. After it has started, go to the location in the `TA_HOST`. This should give you the standard TubeArchivist login screen.
 <!-- 
 ### Docker-Compose Setup -->

mkdocs/docs/Playlists.md

@@ -15,7 +15,8 @@ The **Subscribe to Playlist** button <img src="/assets/icon-add.png?raw=true" al
     - `https://www.youtube.com/playlist?list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha`
 - If you want to subscribe to more than one playlist directly, you can add one playlist per line in the text field
 
-NOTE: It doesn't make sense to subscribe to a playlist if you are already subscribed the corresponding channel as this will slow down the **Rescan Subscriptions** [task](Downloads.md#rescan-subscriptions).
+!!! note
+    It doesn't make sense to subscribe to a playlist if you are already subscribed the corresponding channel as this will slow down the **Rescan Subscriptions** [task](Downloads.md#rescan-subscriptions).
 
 You can search your indexed playlists by clicking on the search icon <img src="/assets/icon-search.png?raw=true" alt="search icon" width="20px" style="margin:0 5px;">. This will open a dedicated page.
 

mkdocs/docs/Settings.md

@@ -104,10 +104,10 @@ Examples:
 - `auto`: Sensible default.
 - `0`: (zero), deactivate that task.
 
-NOTE:
-- Changes in the scheduler settings require a container restart to take effect.
-- Cron format as *number*/*number* are none standard cron and are not supported by the scheduler, for example `0 0/12 *` is invalid, use `0 */12 *` instead.
-- Avoid an unnecessary frequent schedule to not get blocked by YouTube. For that reason, the scheduler doesn't support schedules that trigger more than once per hour.
+!!! note "BE AWARE"
+    - Changes in the scheduler settings require a container restart to take effect.
+    - Cron format as *number*/*number* are none standard cron and are not supported by the scheduler, for example `0 0/12 *` is invalid, use `0 */12 *` instead.
+    - Avoid an unnecessary frequent schedule to not get blocked by YouTube. For that reason, the scheduler doesn't support schedules that trigger more than once per hour.
 
 ## Rescan Subscriptions
 That's the equivalent task as run from the downloads page looking through your channel and playlist and add missing videos to the download queue.
@@ -134,7 +134,8 @@ Additional database functionality.
 The button **Delete all queued** will delete all pending videos from the download queue. The button **Delete all ignored** will delete all videos you have previously ignored.
 
 ## Manual Media Files Import
-NOTE: This is inherently error prone, as there are many variables, some outside of the control of this project. Read this carefully and use at your own risk. 
+!!! note "BE AWARE"
+    This is inherently error prone, as there are many variables, some outside of the control of this project. Read this carefully and use at your own risk. 
 
 Add the files you'd like to import to the */cache/import* folder. Only add files, don't add subdirectories. All files you are adding, need to have the same *base name* as the media file. Then start the process from the settings page *Manual Media Files Import*.
 
@@ -142,6 +143,7 @@ Valid media extensions are *.mp4*, *.mkv* or *.webm*. If you have other file ext
 
 ### Method 1:
 Add a matching *.info.json* file with the media file. Both files need to have the same base name, for example:
+
 - For the media file: `<base-name>.mp4`
 - For the JSON file: `<base-name>.info.json`
 
@@ -149,17 +151,20 @@ The import process then looks for the 'id' key within the JSON file to identify
 
 ### Method 2:
 Detect the YouTube ID from filename, this accepts the default yt-dlp naming convention for file names like:
+
 - `<base-name>[<youtube-id>].mp4`
 - The YouTube ID in square brackets at the end of the filename is the crucial part.
 
 ### Offline import:
 If the video you are trying to import is not available on YouTube any more, **Tube Archivist** can import the required metadata:
+
 - The file `<base-name>.info.json` is required to extract the required information.
 - Add the thumbnail as `<base-name>.<ext>`, where valid file extensions are *.jpg*, *.png* or *.webp*. If there is no thumbnail file, **Tube Archivist** will try to extract the embedded cover from the media file or will fallback to a default thumbnail.
 - Add subtitles as `<base-name>.<lang>.vtt` where *lang* is the two letter ISO country code. This will archive all subtitle files you add to the import folder, independent from your configurations. Subtitles can be archived and used in the player, but they can't be indexed or made searchable due to the fact, that they have a very different structure than the subtitles as **Tube Archivist** needs them.
 - For videos, where the whole channel is not available any more, you can add the `<channel-id>.info.json` file as generated by *youtube-dl/yt-dlp* to get the full metadata. Alternatively **Tube Archivist** will extract as much info as possible from the video info.json file. 
 
 ### Some notes:
+
 - This will **consume** the files you put into the import folder: Files will get converted to mp4 if needed (this might take a long time...) and moved to the archive, *.json* files will get deleted upon completion to avoid having duplicates on the next run.
 - For best file transcoding quality, convert your media files with desired settings first before importing.
 - Maybe start with a subset of your files to import to make sure everything goes well...
@@ -171,7 +176,8 @@ This will write or overwrite all thumbnails in the media file using the download
 ## ZIP file index backup
 This will backup your metadata into a zip file. The file will get stored at *cache/backup* and will contain the necessary files to restore the Elasticsearch index formatted **nd-json** files. For data consistency, make sure there aren't any other tasks running that will change the index during the backup process. This is very slow, particularly for large archives.  
 
-NOTE: **BE AWARE** This will **not** backup any media files, just the metadata from the Elasticsearch.
+!!! note "BE AWARE"
+    This will **not** backup any media files, just the metadata from the Elasticsearch.
 
 ## Restore From Backup
 The restore functionality will expect the same zip file in *cache/backup* as created from the **Backup database** function. This will recreate the index from the snapshot. There will be a list of all available backup to choose from. The *source* tag can have these different values:
@@ -192,4 +198,5 @@ This function will go through all your media files and looks at the whole index
 - The task will stop, when adding a video fails, for example if the video is no longer available on YouTube.
 - This will also check all of your thumbnails and download any that are missing.
 
-NOTE: **BE AWARE** There is no undo.
+!!! note "BE AWARE"
+    There is no undo.

mkdocs/docs/Users.md

@@ -17,4 +17,5 @@ You can delete or change permissions and password of a user by clicking on the u
 ## Reset
 Delete all user configurations by deleting the file `cache/db.sqlite3` and restart the container. This will create the superuser again from the environment variables.
 
-NOTE: Future improvements here will most likely require such a reset.
+!!! note "BE AWARE"
+    Future improvements here will most likely require such a reset.

mkdocs/mkdocs.yml

@@ -21,6 +21,8 @@ repo_url: https://github.com/tubearchivist/docs
 markdown_extensions:
     - toc:
         permalink: "#"
-    - callouts
+    - admonition
+    - pymdownx.details
+    - pymdownx.superfences
 theme:
   name: material