Skip to main content

🏷️ Version Display

Dynamic version information display with build dates, Git commits, and environment indicators. Perfect for tracking releases, deployments, and development builds.

🔄 Live Version Display

Current version information for this Docusaurus Template:

v2025.08.24

🎨 Display Formats

📋 Full Version Information

Shows complete version details including build metadata:

v2025.08.24
  • ✅ Version number with semantic versioning
  • ✅ Build date and time
  • ✅ Git commit hash
  • ✅ Environment indicator
  • ✅ Custom labels and badges

🌍 Environment Examples

🚀 Production

v1.1.2
Built: 2025-08-24

Stable release with clean version numbers and release indicators.

🧪 Development

v1.2.0-beta.1
Commit: f4e5d6c

Beta versions with commit hashes and development indicators.

🎯 Custom

2024.08.15
Release Candidate

Custom versioning schemes like date-based or semantic release candidates.

⚙️ Configuration

Basic Usage

import VersionDisplay from '@site/src/components/VersionDisplay';

// Default display (uses version.yml configuration)
<VersionDisplay />

// Custom format
<VersionDisplay format="short" />
<VersionDisplay format="minimal" />

// In navbar (automatic integration)
// Component is available as navbar item

Version Configuration (version.yml)

version: "3.1.2"
buildDate: "2024-08-15"
gitCommit: "a1b2c3d"
environment: "production"
customLabel: "Stable Release"

# Optional display settings
showBuildDate: true
showGitCommit: true
showEnvironment: true
dateFormat: "YYYY-MM-DD"

⚡ Integration Features

🔧 Automatic Integration

  • ✅ Build Pipeline: Auto-updated during builds
  • ✅ Git Integration: Automatic commit hash detection
  • ✅ Environment Detection: NODE_ENV aware
  • ✅ Navbar Item: Available in navigation

🎨 Display Options

  • ✅ Theme Aware: Adapts to site theme
  • ✅ Responsive: Works on all screen sizes
  • ✅ Accessible: Screen reader friendly
  • ✅ Customizable: Override styles and formats

💡 Common Use Cases

📱 Application Tracking

  • Mobile app version tracking
  • Web application releases
  • API version management
  • Deployment verification

📚 Documentation Sites

  • Documentation version sync
  • Content release tracking
  • Build verification
  • User support assistance

🔗 Related Resources

Learn more about version management and build automation:

📖 Version System Docs🔄 Pre-build System