website-and-documentation/static/js/likec4-loader.js

87 lines
3.2 KiB
JavaScript
Raw Normal View History

feat(docs): integrate LikeC4 interactive diagrams into Hugo/Docsy Implement complete integration of LikeC4 interactive architecture diagrams into the Hugo/Docsy documentation system, enabling embedded web components for exploring C4 models directly in documentation pages. Integration Components: Static Assets: - static/js/likec4-webcomponent.js (3.1 MB) - Generated web component containing all 54 C4 views as interactive embeddable elements - static/js/likec4-loader.js - Dynamic ES6 module loader with fallback paths for robust component loading across different page depths - static/css/likec4-styles.css - Styling for diagram containers with dark mode support for Docsy theme compatibility Hugo Configuration: - hugo.toml - Added params.likec4.enable configuration flag - layouts/partials/hooks/head-end.html - Hook to inject CSS and JS when LikeC4 is enabled site-wide Documentation: - content/en/docs/architecture/_index.md - Architecture section index - content/en/docs/architecture/highlevelarch.md - Example page with interactive OTC FaaS deployment diagram demonstrating integration - content/en/docs/architecture/setup.md - Comprehensive setup guide covering installation, usage, workflow, and troubleshooting - resources/likec4/INTEGRATION.md - Technical integration details - LIKEC4-QUICKSTART.md - Quick start guide for developers Features: - Interactive diagram exploration (click components for details) - Automatic loading indicators with timeout fallback - Graceful degradation for non-JS environments - Dark mode support matching Docsy theme - Multiple diagrams per page support - Browser compatibility detection Usage Pattern: ```html <div class="likec4-container"> <div class="likec4-header">Diagram Title</div> <likec4-view view-id="otc-faas" browser="true"></likec4-view> <div class="likec4-loading">Loading...</div> </div> ``` Workflow: 1. Edit .c4 files in resources/likec4/ 2. Run: npx likec4 gen webcomponent --webcomponent-prefix likec4 --outfile ../../static/js/likec4-webcomponent.js 3. Commit both model changes and regenerated webcomponent Available Views: - otc-faas, edp, landscape, edpbuilderworkflow - keycloak, forgejo, argocd, crossplane, monitoring - And 40+ more component and deployment views The integration preserves the MkDocs-style embedding approach from edp-doc while adapting it to Hugo's static site generation model. This completes the migration making this repository the central hub for both C4 architecture models and their rendered documentation.
2025-10-24 13:08:59 +02:00
/* LikeC4 Webcomponent Loader for Hugo/Docsy */
(function() {
'use strict';
// Check if the component is already loaded
if (customElements.get('likec4-view')) {
console.log('LikeC4 component already loaded');
return;
}
// Function to dynamically import the ES6 module
function loadLikeC4Module() {
// Try different possible paths for the webcomponent
const possiblePaths = [
// Absolute Hugo paths (most likely to work)
'/js/likec4-webcomponent.js',
// Relative paths from current page
'../js/likec4-webcomponent.js',
'../../js/likec4-webcomponent.js',
'../../../js/likec4-webcomponent.js',
// Fallback paths
'./js/likec4-webcomponent.js',
'js/likec4-webcomponent.js'
];
let pathIndex = 0;
function tryNextPath() {
if (pathIndex >= possiblePaths.length) {
console.error('All module paths failed');
showErrorMessage('Failed to load interactive diagram module');
return;
}
const modulePath = possiblePaths[pathIndex];
console.log(`Trying to load LikeC4 module from: ${modulePath}`);
// Dynamic import with error handling
try {
const importFunction = new Function('specifier', 'return import(specifier)');
importFunction(modulePath)
.then(function(module) {
console.log('LikeC4 webcomponent loaded successfully');
// Hide any loading indicators
hideLoadingIndicators();
})
.catch(function(error) {
console.warn(`Failed to load from ${modulePath}:`, error.message);
pathIndex++;
tryNextPath();
});
} catch (error) {
console.warn(`Dynamic import failed for ${modulePath}:`, error.message);
pathIndex++;
tryNextPath();
}
}
tryNextPath();
}
function hideLoadingIndicators() {
const loadingElements = document.querySelectorAll('.likec4-loading, #likec4-loading');
loadingElements.forEach(function(el) {
el.style.display = 'none';
});
}
function showErrorMessage(message) {
const containers = document.querySelectorAll('.likec4-container');
containers.forEach(function(container) {
const errorDiv = document.createElement('div');
errorDiv.style.cssText = 'position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%); color: #dc3545; text-align: center; font-size: 14px; max-width: 300px;';
errorDiv.textContent = message;
container.appendChild(errorDiv);
});
hideLoadingIndicators();
}
// Check if DOM is ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', loadLikeC4Module);
} else {
loadLikeC4Module();
}
})();