Inside index.html
This document provides a comprehensive inventory of what is stored in the final index.html
file generated by Spec-Up-T.
HTML Structure Overview
The index.html
file is a complete single-page application (SPA) that contains a technical specification document with interactive features. It's based on Bootstrap 5.3 and includes extensive JavaScript functionality.
Template Variables Interpolated
The following variables are interpolated into the HTML template during the build process:
Basic Metadata
${title}
- Document title from spec configuration${description}
- Document description from spec configuration${author}
- Document author from spec configuration${specFavicon}
- Path to favicon file${specLogo}
- Path to specification logo${specLogoLink}
- Link associated with the logo
Content Sections
${toc}
- Generated table of contents HTML${render}
- Main specification content rendered from markdown files${externalReferences}
- HTML content for external specification references${externalSpecsList}
- List of external specifications in the sidebar
Assets and Resources
${assetsHead}
- CSS and JavaScript files for the document head${assetsBody}
- JavaScript files for the document body${assetsSvg}
- SVG icon definitions${xtrefsData}
- External cross-reference data as embedded JavaScript
Configuration Data
${features}
- Space-separated list of enabled features${spec}
- Complete specification configuration as JSON string
Embedded JavaScript Variables
Primary Configuration Object
window.specConfig = ${spec}
This contains the complete specification configuration as a JavaScript object, including:
- Specification metadata (title, description, author)
- File paths and directory structure
- External specifications configuration
- Asset definitions
- Feature flags
- Output paths
External Cross-References Data
The ${xtrefsData}
variable contains a <script>
tag with external term reference data loaded from .cache/xtrefs-data.js
if it exists. This enables cross-specification term linking.