Update docs

Author: rnag

.github/workflows/gh-pages.yml

@@ -1,4 +1,5 @@
-name: Deploy Docs to GitHub Pages
+# Deploy Docs to GitHub Pages
+name: docs
 
 on:
   push:

.github/workflows/release.yml

@@ -1,11 +1,10 @@
-# Publish package on main branch if it's tagged with 'v*'
-# Ref: https://github.community/t/run-workflow-on-push-tag-on-specific-branch/17519
-
+# Build & Release
 name: release
 
 # Controls when the action will run.
 on:
-  # Triggers the workflow on push or pull request events but only for the master branch
+  # Publish package on main branch if it's tagged with 'v*'
+  # Ref: https://github.community/t/run-workflow-on-push-tag-on-specific-branch/17519
   push:
     tags:
       - 'v*'

README.md

@@ -6,18 +6,18 @@
 [![PyPI license](https://img.shields.io/pypi/l/secrets-cache.svg)](https://pypi.org/project/secrets-cache/)
 [![PyPI Python versions](https://img.shields.io/pypi/pyversions/secrets-cache.svg)](https://pypi.org/project/secrets-cache/)
 [![GitHub Actions](https://github.com/rnag/py-secrets-cache/actions/workflows/release.yml/badge.svg)](https://github.com/rnag/py-secrets-cache/actions/workflows/release.yml)
-[![Documentation Status](https://github.com/rnag/py-secrets-cache/actions/workflows/pages/pages-build-deployment/badge.svg)](https://ritviknag.com/py-secrets-cache/)
+[![Documentation Status](https://github.com/rnag/py-secrets-cache/actions/workflows/gh-pages.yml/badge.svg)](https://secrets-cache.ritviknag.com)
 
-!!! tip
-    Check out [secrets-cache-cdk-example](https://github.com/rnag/secrets-cache-cdk-example)
-    for a ready-to-deploy AWS Lambda + CDK project demonstrating `secrets-cache` usage
-    with Secrets Manager and SSM parameters, including caching timings.
+> [!TIP]
+> Check out [secrets-cache-cdk-example](https://github.com/rnag/secrets-cache-cdk-example)
+> for a ready-to-deploy AWS Lambda + CDK project demonstrating `secrets-cache` usage
+> with Secrets Manager and SSM parameters, including caching timings.
 
 Cache secrets locally from AWS Secrets Manager and other secret stores, with optional local caching for development or Lambda-friendly usage.
 
 * PyPI package: https://pypi.org/project/secrets-cache/
 * Free software: MIT License
-* Documentation: https://ritviknag.com/py-secrets-cache/
+* Documentation: https://secrets-cache.ritviknag.com
 
 ## Installation
 

mkdocs.yml

@@ -1,12 +1,12 @@
 site_name: "Secrets Cache"
-site_url: "http://ritviknag.com/secrets-cache/"
+site_url: "https://secrets-cache.ritviknag.com"
 theme:
   name: material
   features:
     - navigation.tabs
     - navigation.instant
 markdown_extensions:
-  - admonition      # enables [!TIP], [!NOTE], etc.
+  - admonition
   - codehilite
   - toc:
       permalink: true
@@ -24,4 +24,4 @@ docs_dir: docs
 plugins:
   - search
   - include-markdown
-
+  - gh-admonitions  # enables [!TIP], [!NOTE], etc.

pyproject.toml

@@ -45,6 +45,7 @@ local = [
 docs = [
     'mkdocs',
     'mkdocs-material',
+    'mkdocs-github-admonitions-plugin',
     'mkdocs-markdownextradata-plugin',
     'mkdocs-macros-plugin',
     'mkdocs-include-markdown-plugin',