// Select the SVG element
const svg = d3.select("#tech-radar .radar-svg");
- const tooltip = d3.select("#tooltip");
// Function to render the radar
function renderRadar() {
@@ -549,7 +604,32 @@
{{ title }}
};
// Create the shape for this entry
- createShape(d.moved, pos.x, pos.y, ring.color);
+ const shape = createShape(d.moved, pos.x, pos.y, ring.color);
+
+ // Add tooltip functionality using custom div
+ const ringInfo = config.rings[d.ring];
+ const quadrant = config.quadrants[d.quadrant];
+ const titleText = `${d.label} ${quadrant.name} - ${ringInfo.name}${d.description ? ' ' + d.description : ''}`;
+
+ // Get tooltip element
+ const tooltip = document.getElementById('radar-tooltip');
+
+ // Add mouse event handlers
+ shape.on('mouseenter', function(event) {
+ tooltip.innerHTML = titleText;
+ tooltip.classList.add('visible');
+
+ // Position tooltip near cursor
+ const rect = svg.node().getBoundingClientRect();
+ const mouseX = event.clientX - rect.left;
+ const mouseY = event.clientY - rect.top;
+
+ tooltip.style.left = (mouseX + 10) + 'px';
+ tooltip.style.top = (mouseY - 40) + 'px';
+ })
+ .on('mouseleave', function() {
+ tooltip.classList.remove('visible');
+ });
// Add number label on top of the shape
group.append("text")
@@ -561,49 +641,6 @@
{{ title }}
.attr("font-weight", "bold")
.attr("text-anchor", "middle")
.attr("pointer-events", "none");
-
- // Hover effects
- group
- .on("mouseover", function(event, d) {
- const ring = config.rings[d.ring];
- const quadrant = config.quadrants[d.quadrant];
- const entryPos = d.calculatedPos;
-
- // Get the container position to calculate relative positioning
- const containerRect = document.querySelector('.radar-container').getBoundingClientRect();
- const svgRect = document.querySelector('.radar-svg').getBoundingClientRect();
-
- // Calculate tooltip position relative to the point
- const tooltipX = svgRect.left + entryPos.x * (svgRect.width / width) - containerRect.left;
- const tooltipY = svgRect.top + entryPos.y * (svgRect.height / height) - containerRect.top;
-
- tooltip
- .style("display", "block")
- .html(`
- ${d.label}
- ${quadrant.name} - ${ring.name}
- ${d.description || ''}
- ${d.movement ? ` ${d.movement}` : ''}
- `)
- .style("left", (tooltipX + 15) + "px")
- .style("top", (tooltipY - 35) + "px");
- })
- .on("mousemove", function(event, d) {
- // Keep tooltip position fixed to the point, don't follow mouse
- const containerRect = document.querySelector('.radar-container').getBoundingClientRect();
- const svgRect = document.querySelector('.radar-svg').getBoundingClientRect();
- const entryPos = d.calculatedPos;
-
- const tooltipX = svgRect.left + entryPos.x * (svgRect.width / width) - containerRect.left;
- const tooltipY = svgRect.top + entryPos.y * (svgRect.height / height) - containerRect.top;
-
- tooltip
- .style("left", (tooltipX + 15) + "px")
- .style("top", (tooltipY - 35) + "px");
- })
- .on("mouseout", function() {
- tooltip.style("display", "none");
- });
});
console.log("Tech Radar rendered with", config.entries.length, "entries");
diff --git a/pyproject.toml b/pyproject.toml
index e23d5b2..b850187 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -7,6 +7,7 @@ authors = [
]
readme = "README.md"
license = "Apache-2.0"
+keywords = ["mkdocs", "mkdocs-plugin", "documentation", "tech-radar"]
requires-python = ">=3.10"
dependencies = [
"mkdocs>=1.4.0",
@@ -29,6 +30,9 @@ build-backend = "setuptools.build_meta"
include = ["mkdocs_tech_radar*"]
exclude = ["site*", "tests*"]
+[tool.setuptools.package-data]
+mkdocs_tech_radar = ["templates/*"]
+
[dependency-groups]
dev = [
"commitizen>=4.8.3",
From 6dfce8b8ce0e9a24621cb73b06835f7aea95507d Mon Sep 17 00:00:00 2001
From: thatmlopsguy <165834479+thatmlopsguy@users.noreply.github.com>
Date: Thu, 21 Aug 2025 16:15:28 +0100
Subject: [PATCH 13/21] feat: add Makefile for project management and enhance
dev dependencies in pyproject.toml
---
Makefile | 110 +++++++++++++++++++++++++++++++++++++++++++++++++
pyproject.toml | 2 +
2 files changed, 112 insertions(+)
create mode 100644 Makefile
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..8b5ee20
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,110 @@
+.PHONY: help install dev test clean build serve lint format check docs
+
+##@ General
+help: ## Show this help
+ @awk 'BEGIN {FS = ":.*##"; printf "\nUsage: \033[36m\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf " \033[36m%-26s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+##@ Environment setup
+install: ## Install dependencies using uv
+ uv sync
+
+dev: ## Install development dependencies
+ uv sync --dev
+
+##@ Development
+serve: ## Start the MkDocs development server
+ uv run mkdocs serve
+
+serve-custom: ## Start the MkDocs development server on custom port
+ uv run mkdocs serve --dev-addr 127.0.0.1:8001
+
+build: ## Build the MkDocs site
+ uv run mkdocs build
+
+##@ Package management
+install-pkg: ## Install the package in editable mode
+ uv pip install --editable .
+
+reinstall: ## Uninstall and reinstall the package
+ uv pip uninstall mkdocs-tech-radar -q && uv pip install --editable . -q
+
+##@ Testing
+test: ## Run tests (installs dev dependencies if needed)
+ @uv sync --dev --quiet
+ uv run pytest
+
+test-verbose: ## Run tests with verbose output
+ @uv sync --dev --quiet
+ uv run pytest -v
+
+test-coverage: ## Run tests with coverage report
+ @uv sync --dev --quiet
+ uv run pytest --cov=mkdocs_tech_radar --cov-report=html --cov-report=term
+
+##@ Code quality
+lint: ## Run linting with ruff
+ uv run ruff check .
+
+lint-fix: ## Run linting and fix auto-fixable issues
+ uv run ruff check . --fix
+
+format: ## Format code with ruff
+ uv run ruff format .
+
+format-check: ## Check code formatting without making changes
+ uv run ruff format . --check
+
+check: ## Run all quality checks (lint + format check + test)
+ @uv sync --dev --quiet
+ uv run ruff check .
+ uv run ruff format . --check
+ uv run pytest
+
+##@ Documentation
+docs-build: ## Build documentation
+ uv run mkdocs build
+
+docs-deploy: ## Deploy documentation to GitHub Pages
+ uv run mkdocs gh-deploy
+
+##@ Cleanup
+clean: ## Remove build artifacts and cache
+ rm -rf build/
+ rm -rf dist/
+ rm -rf site/
+ rm -rf *.egg-info/
+ find . -type d -name __pycache__ -exec rm -rf {} +
+ find . -type f -name "*.pyc" -delete
+
+clean-venv: ## Remove virtual environment
+ rm -rf .venv
+
+##@ Package building and publishing
+build-package: ## Build the package
+ uv build
+
+publish-test: ## Publish to TestPyPI
+ uv publish --repository testpypi
+
+publish: ## Publish to PyPI
+ uv publish
+
+##@ Dependency management
+update: ## Update dependencies
+ uv sync --upgrade
+
+lock: ## Update lock file
+ uv lock
+
+add: ## Add a new dependency (use: make add PKG=package_name)
+ uv add $(PKG)
+
+add-dev: ## Add a new development dependency (use: make add-dev PKG=package_name)
+ uv add --dev $(PKG)
+
+remove: ## Remove a dependency (use: make remove PKG=package_name)
+ uv remove $(PKG)
+
+##@ Utility
+show: ## Show installed packages
+ uv pip list
diff --git a/pyproject.toml b/pyproject.toml
index b850187..463e503 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -37,6 +37,8 @@ mkdocs_tech_radar = ["templates/*"]
dev = [
"commitizen>=4.8.3",
"prek>=0.1.1",
+ "pytest>=8.4.1",
+ "pytest-cov>=6.2.1",
"ruff>=0.12.9",
]
From 6b6dff39527eabd66c9d23b13428300b449b7419 Mon Sep 17 00:00:00 2001
From: thatmlopsguy <165834479+thatmlopsguy@users.noreply.github.com>
Date: Thu, 21 Aug 2025 16:27:51 +0100
Subject: [PATCH 14/21] docs: streamline README by removing redundant features
section and enhancing clarity on radar file structure
---
README.md | 95 ++++++++++++++-----------------------------------------
1 file changed, 23 insertions(+), 72 deletions(-)
diff --git a/README.md b/README.md
index f86bd73..eec16f5 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,14 @@
# MkDocs Tech Radar Plugin
A MkDocs plugin that generates an interactive Technology Radar based on the [Zalando Tech Radar](https://github.com/zalando/tech-radar) implementation.
-This plugin helps engineering teams visualize and track their technology adoption, assessment, and decisions across multiple radar versions.
-## Features
+This plugin helps engineering teams visualize and track their technology adoption, assessment, and decisions.
-- 🎯 **Interactive visualization** with D3.js-powered radar chart
-- 📊 **Four-ring assessment model** (Adopt, Trial, Assess, Hold)
-- 🏗️ **Four-quadrant organization** (Frameworks, Tools, Platforms, Techniques)
-- 🎭 **Movement indicators** (moved up ▲, moved down ▼, new ★, no change ⬤)
-- 💡 **Hover tooltips** and interactive legend
-- ️🎨 **Multiple radar versions** - supports a folder of radar files with dropdown selector
-- 🌙 **Dark mode support** - automatically adapts to MkDocs Material theme
-- 📋 **Inline embedding** - radar is embedded directly in your documentation pages
+See [live demo](https://thatmlopsguy.github.io/mkdocs-tech-radar)
## Installation
-Install the plugin using uv, pip, or your preferred Python package manager:
+Install the plugin using `uv`, `pip`, or your preferred Python package manager:
```bash
# Using uv
@@ -30,6 +22,16 @@ pip install mkdocs-tech-radar
Add the plugin to your `mkdocs.yml`:
+### Parameters
+
+| Option | Type | Default | Description |
+|-----------------|--------|----------------------|------------------------------------|
+| `title_name` | string | `'Technology Radar'` | Title for the radar |
+| `target_page` | string | `'tech-radar.md'` | Page to embed the radar in |
+| `radars_folder` | string | `'radars'` | Folder containing radar JSON files |
+
+### Example:
+
```yaml
plugins:
- tech-radar:
@@ -40,9 +42,7 @@ plugins:
## Usage
-### Creating Multiple Radar Files
-
-Create multiple JSON files in a `docs/radars/` folder for different radar versions:
+Create one or multiple JSON files in a `docs/radars/` folder for different radar versions:
```text
docs/
@@ -52,43 +52,18 @@ docs/
2025-09-01.json
```
+**Note:** Use date-based naming for optimal sorting:
+
+- `2025-08-20.json` - August 20, 2025 version
+- `2025-09-01.json` - September 1, 2025 version
+- `2025-12-15.json` - December 15, 2025 version
+
The plugin will:
- Automatically load all JSON files from the `radars_folder`
- Display a dropdown selector for switching between radar versions
- Default to the newest version (based on filename sorting)
-Example radar file (`docs/radars/2025-08-20.json`):
-
-```json
-{
- "date": "2025-08-20",
- "quadrants": [
- {"name": "Languages & Frameworks"},
- {"name": "Tools"},
- {"name": "Platforms"},
- {"name": "Techniques"}
- ],
- "rings": [
- {"name": "ADOPT", "color": "#5ba300", "description": "Technologies we have high confidence in"},
- {"name": "TRIAL", "color": "#009eb0", "description": "Worth pursuing with small risks"},
- {"name": "ASSESS", "color": "#c7ba00", "description": "Worth exploring with higher risks"},
- {"name": "HOLD", "color": "#e09b96", "description": "Proceed with caution or avoid"}
- ],
- "entries": [
- {
- "label": "React",
- "quadrant": 0,
- "ring": 0,
- "moved": 0,
- "active": true,
- "description": "A JavaScript library for building user interfaces",
- "link": "https://reactjs.org/"
- }
- ]
-}
-```
-
### Adding Radar to Your Documentation
Add the radar placeholder in your target markdown page:
@@ -105,39 +80,13 @@ Additional content can go here after the radar.
The `` placeholder will be replaced with the interactive radar visualization.
-### Multiple Radar Versions
-
-The plugin provides these features for managing multiple radar versions:
-
-#### Version Selection
-
-- **Dropdown menu**: Appears automatically when multiple radar files are detected
-- **Date-based sorting**: Files are sorted by filename (assuming YYYY-MM-DD format)
-- **Auto-selection**: Newest version is selected by default
-- **Dynamic switching**: Users can switch between radar versions without page reload
-
-#### File Naming Convention
-
-Use date-based naming for optimal sorting:
-
-- `2025-08-20.json` - August 20, 2025 version
-- `2025-09-01.json` - September 1, 2025 version
-- `2025-12-15.json` - December 15, 2025 version
-
#### Recommended Workflow
1. Create a new radar file for each release/quarter
2. Copy the previous version as a starting point
3. Update entries with new technologies and movement indicators
4. The plugin automatically detects and makes it available
-
-## Configuration Options
-
-| Option | Type | Default | Description |
-|-----------------|--------|----------------------|------------------------------------|
-| `title_name` | string | `'Technology Radar'` | Title for the radar |
-| `target_page` | string | `'tech-radar.md'` | Page to embed the radar in |
-| `radars_folder` | string | `'radars'` | Folder containing radar JSON files |
+5. Commit the changes to your version control system
## Radar File Structure
@@ -176,6 +125,8 @@ Each entry in the `entries` array must have:
### Example Complete Radar File
+Example radar file (`docs/radars/2025-08-20.json`):
+
```json
{
"date": "2025-08-20",
From 0ff374f0a0f8d1eb912f0cad2a5b7accbe1ff8c2 Mon Sep 17 00:00:00 2001
From: thatmlopsguy <165834479+thatmlopsguy@users.noreply.github.com>
Date: Thu, 21 Aug 2025 16:37:26 +0100
Subject: [PATCH 15/21] feat: add GitHub Actions workflow for documentation
build and deployment; update Python version requirement in pyproject.toml
---
.github/workflows/docs.yml | 80 ++++++++++++++++++++++++++++++++++++++
.vscode/settings.json | 5 +++
pyproject.toml | 2 +-
3 files changed, 86 insertions(+), 1 deletion(-)
create mode 100644 .github/workflows/docs.yml
create mode 100644 .vscode/settings.json
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..e86eb85
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,80 @@
+name: docs
+
+on:
+ push:
+ branches:
+ - main
+ - dev
+ paths:
+ - 'docs/**'
+ - 'mkdocs.yml'
+ - 'mkdocs_tech_radar/**'
+ - 'pyproject.toml'
+
+ pull_request:
+ branches:
+ - main
+ paths:
+ - 'docs/**'
+ - 'mkdocs.yml'
+ - 'mkdocs_tech_radar/**'
+ - 'pyproject.toml'
+
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+ group: "pages"
+ cancel-in-progress: false
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+ with:
+ fetch-depth: 0
+
+ - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+ with:
+ python-version: 3.12
+
+ - name: Install uv
+ uses: astral-sh/setup-uv@v5
+ with:
+ version: "latest"
+
+ - name: Install dependencies and plugin
+ run: |
+ uv pip install --system --editable .
+
+ - name: Setup Pages
+ id: pages
+ uses: actions/configure-pages@v5
+
+ - name: Build documentation
+ run: |
+ uv run mkdocs build --config-file mkdocs.yml
+
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: ./site
+
+ deploy:
+ if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ needs: build
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v5
+
+
diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 0000000..5ca369d
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+ "cSpell.words": [
+ "pyproject"
+ ]
+}
diff --git a/pyproject.toml b/pyproject.toml
index 463e503..13af7d3 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -8,7 +8,7 @@ authors = [
readme = "README.md"
license = "Apache-2.0"
keywords = ["mkdocs", "mkdocs-plugin", "documentation", "tech-radar"]
-requires-python = ">=3.10"
+requires-python = ">=3.12"
dependencies = [
"mkdocs>=1.4.0",
"jinja2>=3.0.0",
From 8f8cb6c19b5331385b9b47c15e3f60a6b5583923 Mon Sep 17 00:00:00 2001
From: thatmlopsguy <165834479+thatmlopsguy@users.noreply.github.com>
Date: Thu, 21 Aug 2025 16:43:31 +0100
Subject: [PATCH 16/21] fix: update deploy action version to v4 in GitHub
Actions workflow; add documentation badge to README
---
.github/workflows/docs.yml | 2 +-
README.md | 2 ++
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index e86eb85..43bc5f0 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -75,6 +75,6 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
- uses: actions/deploy-pages@v5
+ uses: actions/deploy-pages@v4
diff --git a/README.md b/README.md
index eec16f5..a3af4cd 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# MkDocs Tech Radar Plugin
+[](https://github.com/thatmlopsguy/mkdocs-tech-radar/actions/workflows/docs.yml)
+
A MkDocs plugin that generates an interactive Technology Radar based on the [Zalando Tech Radar](https://github.com/zalando/tech-radar) implementation.
This plugin helps engineering teams visualize and track their technology adoption, assessment, and decisions.
From 45a61f5ec78109d2c2a91146f73ff20c331461d1 Mon Sep 17 00:00:00 2001
From: thatmlopsguy <165834479+thatmlopsguy@users.noreply.github.com>
Date: Thu, 21 Aug 2025 16:46:10 +0100
Subject: [PATCH 17/21] feat: enable manual triggering of documentation
workflow with workflow_dispatch
---
.github/workflows/docs.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 43bc5f0..3c520db 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -1,6 +1,7 @@
name: docs
on:
+ workflow_dispatch:
push:
branches:
- main
From 1831df012cb2f25ce759e0d28a99f33987733191 Mon Sep 17 00:00:00 2001
From: thatmlopsguy <165834479+thatmlopsguy@users.noreply.github.com>
Date: Thu, 21 Aug 2025 16:47:44 +0100
Subject: [PATCH 18/21] fix: comment out conditional deployment for dev branch
in GitHub Actions workflow
---
.github/workflows/docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 3c520db..ff1ee59 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -67,7 +67,7 @@ jobs:
path: ./site
deploy:
- if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
+ # if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
From fb4dee7eda5069d6c6591ce286622cdfe1ec379b Mon Sep 17 00:00:00 2001
From: thatmlopsguy <165834479+thatmlopsguy@users.noreply.github.com>
Date: Thu, 21 Aug 2025 16:57:22 +0100
Subject: [PATCH 19/21] fix: update concurrency settings to cancel in-progress
deployments and remove conditional deployment for dev branch
---
.github/workflows/docs.yml | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index ff1ee59..9c23e25 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -27,10 +27,10 @@ permissions:
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+# Cancel in-progress deployments when a new one is triggered to prevent stuck deployments.
concurrency:
group: "pages"
- cancel-in-progress: false
+ cancel-in-progress: true
jobs:
build:
@@ -67,7 +67,6 @@ jobs:
path: ./site
deploy:
- # if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
From e8dddf46d358466ec6cf80aa654ed16a5708cd43 Mon Sep 17 00:00:00 2001
From: thatmlopsguy <165834479+thatmlopsguy@users.noreply.github.com>
Date: Thu, 21 Aug 2025 17:01:55 +0100
Subject: [PATCH 20/21] fix: update site name and description in mkdocs
configuration; add Tech Radar navigation instruction in index
---
docs/index.md | 2 ++
mkdocs.yml | 4 ++--
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index abfc817..d671431 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -7,3 +7,5 @@ This will not work, because the mkdocs config only check in the `target_page`.
-->
+
+Go to the Tech Radar tab to see the interactive technology radar.
diff --git a/mkdocs.yml b/mkdocs.yml
index c8c9e03..c58b8e2 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,5 +1,5 @@
-site_name: Tech Radar Test
-site_description: Testing the tech-radar plugin
+site_name: Tech Radar Live Demo
+site_description: Demo of the tech-radar mkdocs plugin
site_url: "https://thatmlopsguy.github.io/mkdocs-tech-radar/"
repo_url: "https://github.com/thatmlopsguy/mkdocs-tech-radar"
repo_name: "mkdocs-tech-radar"
From 0bdf663da0283cae95bfb20f3663decc99ecb45f Mon Sep 17 00:00:00 2001
From: thatmlopsguy <165834479+thatmlopsguy@users.noreply.github.com>
Date: Thu, 21 Aug 2025 17:11:48 +0100
Subject: [PATCH 21/21] fix: update GitHub Actions workflow to remove dev
branch from push triggers; update action versions and improve README
formatting
---
.github/workflows/docs.yml | 13 ++++---------
README.md | 8 +++-----
2 files changed, 7 insertions(+), 14 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 9c23e25..b9c924e 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -1,11 +1,9 @@
name: docs
on:
- workflow_dispatch:
push:
branches:
- main
- - dev
paths:
- 'docs/**'
- 'mkdocs.yml'
@@ -40,12 +38,8 @@ jobs:
with:
fetch-depth: 0
- - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
- with:
- python-version: 3.12
-
- name: Install uv
- uses: astral-sh/setup-uv@v5
+ uses: astral-sh/setup-uv@4959332f0f014c5280e7eac8b70c90cb574c9f9b # v6.6.0
with:
version: "latest"
@@ -55,18 +49,19 @@ jobs:
- name: Setup Pages
id: pages
- uses: actions/configure-pages@v5
+ uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
- name: Build documentation
run: |
uv run mkdocs build --config-file mkdocs.yml
- name: Upload artifact
- uses: actions/upload-pages-artifact@v3
+ uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
with:
path: ./site
deploy:
+ if: github.event_name == 'push' && github.ref == 'refs/heads/main'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
diff --git a/README.md b/README.md
index a3af4cd..7886f01 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ A MkDocs plugin that generates an interactive Technology Radar based on the [Zal
This plugin helps engineering teams visualize and track their technology adoption, assessment, and decisions.
-See [live demo](https://thatmlopsguy.github.io/mkdocs-tech-radar)
+**See [live demo](https://thatmlopsguy.github.io/mkdocs-tech-radar)**
## Installation
@@ -32,7 +32,7 @@ Add the plugin to your `mkdocs.yml`:
| `target_page` | string | `'tech-radar.md'` | Page to embed the radar in |
| `radars_folder` | string | `'radars'` | Folder containing radar JSON files |
-### Example:
+### Example
```yaml
plugins:
@@ -73,7 +73,7 @@ Add the radar placeholder in your target markdown page:
```markdown
# Tech Radar
-Our technology radar helps us track the technologies we use and evaluate emerging trends.
+The technology radar helps us track the technologies we use and evaluate emerging trends.
@@ -178,8 +178,6 @@ You can customize the radar appearance by modifying the radar files. The radar u
You can change these colors by modifying the `rings` array in your radar JSON files.
-## Example
-
Check out the included example in the `docs/` directory:
1. Build the documentation: `uv run mkdocs build`