# OntoWave ([Changelog](https://github.com/stephanedenis/OntoWave/blob/main/CHANGELOG.md))
Lightweight JavaScript micro-application (~245KB, ~85KB gzipped) for static sites with multilingual support, syntax highlighting, math formulas and diagrams.
## Features
- **Markdown Processing**: Parse and render Markdown with table alignments support
- **Math Formulas**: KaTeX (LaTeX) support for inline and block equations
- **Syntax Highlighting**: Code blocks with highlight.js (multi-language)
- **Multilingual Support**: Built-in internationalization (i18n) with auto language detection
- **Mermaid Diagrams**: Render flowcharts, sequence diagrams, class diagrams as inline SVG
- **PlantUML Support**: UML diagrams via Kroki.io with inline SVG rendering
- **.puml Files**: Direct PlantUML file loading
- **Smart SVG Cache**: In-memory cache with 5min TTL for optimal performance
- **View Modes**: Normal, Split View (source + render), Source-only
- **SPA Routing**: Hash-based navigation without page reload
- **Lightweight**: ~245KB minified (~85KB gzipped), no runtime dependencies
- **Simple Configuration**: Drop-in script with automatic initialization
### π§ͺ Interactive Demonstrations
Explore OntoWave through **interactive and tested demos**:
#### β¨ Base Capabilities (no configuration needed)
- **[Markdown Features](demos/01-base/markdown.html)** - Tables, lists, links, formatting
- **[Mermaid Diagrams](demos/01-base/mermaid.html)** - Flowcharts, sequence, class diagrams
- **[PlantUML via Kroki](demos/01-base/plantuml.html)** - UML diagrams, components
- **[SPA Routing](demos/01-base/routing.html)** - Navigation without reload, 404 handling
#### βοΈ Advanced Configurations
- **[Internationalization](demos/02-config/i18n.html)** - Auto language detection, fallback
- **[View Modes](demos/02-config/view-modes.html)** - Split view, source-only, normal
- **[UI Customization](demos/02-config/ui-custom.html)** - Sidebar, header, TOC, minimal mode
[π See all demos in the catalog β](demos/)
### Usage
```html
My Site with OntoWave
```
That's it! OntoWave loads automatically and displays its interface.
### π Full Technical Documentation
The homepage is intentionally concise. Detailed technical documentation is available in dedicated pages:
- **[Programming & Extensions Guide](specs/programmation-extensions.en.md)** β current API (v1.x), plugin model, constraints and best practices
- **[Bootstrap Interface Specification](specs/interface.en.md)** β minimal host HTML contract, injected config, floating menu behavior
- **[Modular Architecture Specification](specs/architecture.en.md)** β `ContentRenderer`, `ExtensionRegistry`, lazy-load strategy
- **[Technical Roadmap](specs/roadmap.en.md)** β v1.1 / v2.0 workstream status
> Recommendation: use these pages as implementation references; the homepage is a high-level overview.
### ποΈ OntoWave Architecture
#### Component Overview
```plantuml
@startuml Component_Overview
!theme plain
component "index.html" as HTML
component "ontowave.min.js" as Core
component "index.fr.md" as DocFR
component "index.en.md" as DocEN
HTML --> Core : loads
Core --> DocFR : by locale FR
Core --> DocEN : by locale EN
note bottom of HTML : Single entry point\nIntegrated JSON configuration
note bottom of Core : OntoWave Core\n245KB minified (~85KB gzipped)
note bottom of DocFR : French documentation
note bottom of DocEN : English documentation
@enduml
```
#### Main Classes
```plantuml
@startuml Main_Classes
!theme plain
class Loader {
+init()
+loadContent()
}
class UIManager {
+createInterface()
+handleEvents()
}
class FloatingMenu {
+show()
+hide()
+toggle()
}
class ConfigPanel {
+open()
+close()
+saveSettings()
}
class MarkdownProcessor {
+parse()
+render()
}
class I18nSystem {
+setLanguage()
+translate()
}
Loader --> UIManager : uses
Loader --> I18nSystem : uses
UIManager --> FloatingMenu : manages
UIManager --> ConfigPanel : manages
UIManager --> MarkdownProcessor : manages
@enduml
```
#### Plugin System
```plantuml
@startuml Plugin_System
!theme plain
interface SyntaxHighlighter {
+highlight()
}
interface DiagramRenderer {
+render()
}
class HljsPlugin
class MermaidPlugin
class PlantUMLPlugin
SyntaxHighlighter <|.. HljsPlugin
DiagramRenderer <|.. MermaidPlugin
DiagramRenderer <|.. PlantUMLPlugin
class MarkdownProcessor {
+parse()
+render()
}
MarkdownProcessor --> HljsPlugin : uses
MarkdownProcessor --> MermaidPlugin : uses
MarkdownProcessor --> PlantUMLPlugin : uses
@enduml
```
### License
 **StΓ©phane Denis**
OntoWave is released under **CC BY-NC-SA 4.0** (Creative Commons Attribution-NonCommercial-ShareAlike) license.
This software is provided "as is", without warranty of any kind, express or implied. In no event shall the authors be liable for any claim, damages or other liability.
**Source code:** [GitHub - OntoWave](https://github.com/stephanedenis/OntoWave)