feat: add version tracking topbar with GitHub integration to documentation pages

This commit is contained in:
Admin9705
2025-05-16 23:29:50 -04:00
parent de3b0cc721
commit ed2aff2b82
10 changed files with 434 additions and 1 deletions

View File

@@ -5,9 +5,47 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Huntarr.io Applications Documentation</title>
<link rel="stylesheet" href="../css/main.css">
<link rel="stylesheet" href="../css/topbar.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css">
<script src="../js/main.js" defer></script>
<script src="../js/topbar.js" defer></script>
</head>
<body>
<!-- Include top bar -->
<div class="top-bar">
<div class="topbar-section left">
<div class="page-title">Huntarr Documentation</div>
</div>
<div class="topbar-section center">
<div class="version-bar">
<div class="version-item">
<i class="fas fa-code-branch version-icon"></i>
<span>Version <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="version-value">6.5.15</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-cloud-download-alt version-icon"></i>
<span>Latest: <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="latest-version-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-star version-icon star-icon"></i>
<span><a href="https://github.com/plexguide/huntarr" target="_blank"><span id="github-stars-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-code version-icon"></i>
<span class="developer-credit">Developer: <a href="https://github.com/Admin9705/" target="_blank">Admin9705</a></span>
</div>
</div>
</div>
<div class="topbar-section right">
<div class="docs-link">
<a href="https://github.com/plexguide/Huntarr.io/wiki" target="_blank"><i class="fas fa-book"></i> Wiki</a>
</div>
</div>
</div>
<div class="sidebar">
<div class="sidebar-logo">
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">

View File

@@ -3,11 +3,49 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Sonarr Documentation - Huntarr.io</title>
<title>Sonarr - Huntarr.io Documentation</title>
<link rel="stylesheet" href="../css/main.css">
<link rel="stylesheet" href="../css/topbar.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css">
<script src="../js/main.js" defer></script>
<script src="../js/topbar.js" defer></script>
</head>
<body>
<!-- Include top bar -->
<div class="top-bar">
<div class="topbar-section left">
<div class="page-title">Huntarr Documentation</div>
</div>
<div class="topbar-section center">
<div class="version-bar">
<div class="version-item">
<i class="fas fa-code-branch version-icon"></i>
<span>Version <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="version-value">6.5.15</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-cloud-download-alt version-icon"></i>
<span>Latest: <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="latest-version-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-star version-icon star-icon"></i>
<span><a href="https://github.com/plexguide/huntarr" target="_blank"><span id="github-stars-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-code version-icon"></i>
<span class="developer-credit">Developer: <a href="https://github.com/Admin9705/" target="_blank">Admin9705</a></span>
</div>
</div>
</div>
<div class="topbar-section right">
<div class="docs-link">
<a href="https://github.com/plexguide/Huntarr.io/wiki" target="_blank"><i class="fas fa-book"></i> Wiki</a>
</div>
</div>
</div>
<div class="sidebar">
<div class="sidebar-logo">
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">

View File

@@ -0,0 +1,34 @@
<!-- Top navigation bar similar to Huntarr application -->
<div class="top-bar">
<div class="topbar-section left">
<div class="page-title">Huntarr Documentation</div>
</div>
<div class="topbar-section center">
<div class="version-bar">
<div class="version-item">
<i class="fas fa-code-branch version-icon"></i>
<span>Version <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="version-value">6.5.15</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-cloud-download-alt version-icon"></i>
<span>Latest: <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="latest-version-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-star version-icon star-icon"></i>
<span><a href="https://github.com/plexguide/huntarr" target="_blank"><span id="github-stars-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-code version-icon"></i>
<span class="developer-credit">Developer: <a href="https://github.com/Admin9705/" target="_blank">Admin9705</a></span>
</div>
</div>
</div>
<div class="topbar-section right">
<div class="docs-link">
<a href="https://github.com/plexguide/Huntarr.io/wiki" target="_blank"><i class="fas fa-book"></i> Wiki</a>
</div>
</div>
</div>

118
docs/css/topbar.css Normal file
View File

@@ -0,0 +1,118 @@
/* Top bar styling for documentation pages */
.top-bar {
height: 30px;
background: linear-gradient(135deg, rgba(30, 39, 56, 0.95) 0%, rgba(14, 20, 32, 0.95) 50%, rgba(16, 24, 36, 0.95) 100%);
display: flex;
align-items: center;
justify-content: space-between;
padding: 0 15px;
color: #fff;
position: sticky;
top: 0;
z-index: 1000;
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
}
.topbar-section {
display: flex;
align-items: center;
}
.topbar-section.left {
flex: 1;
}
.topbar-section.center {
flex: 3;
justify-content: center;
}
.topbar-section.right {
flex: 1;
justify-content: flex-end;
}
.version-bar {
display: flex;
align-items: center;
font-size: 12px;
}
.version-item {
display: flex;
align-items: center;
margin: 0 3px;
}
.version-icon {
margin-right: 5px;
font-size: 12px;
}
.version-divider {
width: 1px;
height: 14px;
background-color: rgba(255, 255, 255, 0.3);
margin: 0 8px;
}
.star-icon {
color: #f8d12f;
}
a {
color: #3498db;
text-decoration: none;
transition: color 0.2s;
}
a:hover {
color: #2980b9;
}
.developer-credit a {
color: #f0f0f0;
font-weight: 500;
}
.developer-credit a:hover {
color: #3498db;
}
/* Responsive styling */
@media (max-width: 768px) {
.version-bar {
font-size: 11px;
}
.version-divider {
margin: 0 5px;
}
.version-icon {
font-size: 11px;
}
}
@media (max-width: 600px) {
.top-bar {
height: auto;
padding: 5px 10px;
flex-direction: column;
}
.topbar-section {
width: 100%;
justify-content: center;
margin: 2px 0;
}
.version-bar {
flex-wrap: wrap;
justify-content: center;
}
.version-item {
margin: 2px 5px;
}
}

View File

@@ -5,9 +5,47 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installation Guide - Huntarr.io Documentation</title>
<link rel="stylesheet" href="../css/main.css">
<link rel="stylesheet" href="../css/topbar.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css">
<script src="../js/main.js" defer></script>
<script src="../js/topbar.js" defer></script>
</head>
<body>
<!-- Include top bar -->
<div class="top-bar">
<div class="topbar-section left">
<div class="page-title">Huntarr Documentation</div>
</div>
<div class="topbar-section center">
<div class="version-bar">
<div class="version-item">
<i class="fas fa-code-branch version-icon"></i>
<span>Version <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="version-value">6.5.15</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-cloud-download-alt version-icon"></i>
<span>Latest: <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="latest-version-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-star version-icon star-icon"></i>
<span><a href="https://github.com/plexguide/huntarr" target="_blank"><span id="github-stars-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-code version-icon"></i>
<span class="developer-credit">Developer: <a href="https://github.com/Admin9705/" target="_blank">Admin9705</a></span>
</div>
</div>
</div>
<div class="topbar-section right">
<div class="docs-link">
<a href="https://github.com/plexguide/Huntarr.io/wiki" target="_blank"><i class="fas fa-book"></i> Wiki</a>
</div>
</div>
</div>
<div class="sidebar">
<div class="sidebar-logo">
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">

View File

@@ -5,9 +5,47 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Official Huntarr.io Documentation</title>
<link rel="stylesheet" href="css/main.css">
<link rel="stylesheet" href="css/topbar.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css">
<script src="js/main.js" defer></script>
<script src="js/topbar.js" defer></script>
</head>
<body>
<!-- Include top bar -->
<div class="top-bar">
<div class="topbar-section left">
<div class="page-title">Huntarr Documentation</div>
</div>
<div class="topbar-section center">
<div class="version-bar">
<div class="version-item">
<i class="fas fa-code-branch version-icon"></i>
<span>Version <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="version-value">6.5.15</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-cloud-download-alt version-icon"></i>
<span>Latest: <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="latest-version-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-star version-icon star-icon"></i>
<span><a href="https://github.com/plexguide/huntarr" target="_blank"><span id="github-stars-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-code version-icon"></i>
<span class="developer-credit">Developer: <a href="https://github.com/Admin9705/" target="_blank">Admin9705</a></span>
</div>
</div>
</div>
<div class="topbar-section right">
<div class="docs-link">
<a href="https://github.com/plexguide/Huntarr.io/wiki" target="_blank"><i class="fas fa-book"></i> Wiki</a>
</div>
</div>
</div>
<div class="sidebar">
<div class="sidebar-logo">
<img src="images/huntarr-logo.png" alt="Huntarr Logo">

52
docs/js/topbar.js Normal file
View File

@@ -0,0 +1,52 @@
// Top bar functionality for documentation pages
document.addEventListener('DOMContentLoaded', function() {
// Function to fetch the latest version from GitHub
async function fetchGitHubInfo() {
try {
// Fetch GitHub repository information
const repoResponse = await fetch('https://api.github.com/repos/plexguide/Huntarr.io');
const repoData = await repoResponse.json();
// Get star count
if (repoData.stargazers_count) {
document.getElementById('github-stars-value').textContent = repoData.stargazers_count;
}
// Fetch releases information
const releasesResponse = await fetch('https://api.github.com/repos/plexguide/Huntarr.io/releases');
const releasesData = await releasesResponse.json();
if (releasesData && releasesData.length > 0) {
// Get the latest version
const latestVersion = releasesData[0].tag_name;
document.getElementById('latest-version-value').textContent = latestVersion;
}
} catch (error) {
console.error('Error fetching GitHub data:', error);
}
}
// Function to get version from version.txt file
async function fetchCurrentVersion() {
try {
const response = await fetch('/version.txt');
if (response.ok) {
const version = await response.text();
document.getElementById('version-value').textContent = version.trim();
} else {
// Fallback if version.txt is not accessible
const versionElement = document.getElementById('version-value');
if (versionElement) {
// Use the same version as in the main app or a placeholder
versionElement.textContent = '6.5.15';
}
}
} catch (error) {
console.error('Error fetching version:', error);
}
}
// Initial data fetch
fetchCurrentVersion();
fetchGitHubInfo();
});

View File

@@ -5,9 +5,47 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>General Settings - Huntarr.io Documentation</title>
<link rel="stylesheet" href="../css/main.css">
<link rel="stylesheet" href="../css/topbar.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css">
<script src="../js/main.js" defer></script>
<script src="../js/topbar.js" defer></script>
</head>
<body>
<!-- Include top bar -->
<div class="top-bar">
<div class="topbar-section left">
<div class="page-title">Huntarr Documentation</div>
</div>
<div class="topbar-section center">
<div class="version-bar">
<div class="version-item">
<i class="fas fa-code-branch version-icon"></i>
<span>Version <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="version-value">6.5.15</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-cloud-download-alt version-icon"></i>
<span>Latest: <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="latest-version-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-star version-icon star-icon"></i>
<span><a href="https://github.com/plexguide/huntarr" target="_blank"><span id="github-stars-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-code version-icon"></i>
<span class="developer-credit">Developer: <a href="https://github.com/Admin9705/" target="_blank">Admin9705</a></span>
</div>
</div>
</div>
<div class="topbar-section right">
<div class="docs-link">
<a href="https://github.com/plexguide/Huntarr.io/wiki" target="_blank"><i class="fas fa-book"></i> Wiki</a>
</div>
</div>
</div>
<div class="sidebar">
<div class="sidebar-logo">
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">

View File

@@ -5,9 +5,47 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Huntarr.io Settings Documentation</title>
<link rel="stylesheet" href="../css/main.css">
<link rel="stylesheet" href="../css/topbar.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css">
<script src="../js/main.js" defer></script>
<script src="../js/topbar.js" defer></script>
</head>
<body>
<!-- Include top bar -->
<div class="top-bar">
<div class="topbar-section left">
<div class="page-title">Huntarr Documentation</div>
</div>
<div class="topbar-section center">
<div class="version-bar">
<div class="version-item">
<i class="fas fa-code-branch version-icon"></i>
<span>Version <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="version-value">6.5.15</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-cloud-download-alt version-icon"></i>
<span>Latest: <a href="https://github.com/plexguide/Huntarr.io/releases" target="_blank"><span id="latest-version-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-star version-icon star-icon"></i>
<span><a href="https://github.com/plexguide/huntarr" target="_blank"><span id="github-stars-value">--</span></a></span>
</div>
<div class="version-divider"></div>
<div class="version-item">
<i class="fas fa-code version-icon"></i>
<span class="developer-credit">Developer: <a href="https://github.com/Admin9705/" target="_blank">Admin9705</a></span>
</div>
</div>
</div>
<div class="topbar-section right">
<div class="docs-link">
<a href="https://github.com/plexguide/Huntarr.io/wiki" target="_blank"><i class="fas fa-book"></i> Wiki</a>
</div>
</div>
</div>
<div class="sidebar">
<div class="sidebar-logo">
<img src="../images/huntarr-logo.png" alt="Huntarr Logo">

1
docs/version.txt Normal file
View File

@@ -0,0 +1 @@
6.5.15