# wavedrom/wavedrom.github.io architecture

> Architecture diagram of the GitHub repository wavedrom/wavedrom.github.io, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/wavedrom/wavedrom.github.io
- Repository: https://github.com/wavedrom/wavedrom.github.io

## Overview

WaveDrom Editor is a browser and desktop editor for WaveJSON timing diagrams. Users edit diagram descriptions, see rendered output, and can export the description or diagram as SVG/PNG; the README identifies WaveDrom as the rendering engine. The repository also includes a slide-presentation experience and multiple renderer skins. Some key wiring is documented, but the engine implementation is not present in the supplied tree and several source excerpts are partial, so uncertain connections are omitted.

Main entry points: [`editor.js`](https://github.com/wavedrom/wavedrom.github.io/blob/master/editor.js) (Editor controls), [`init.js`](https://github.com/wavedrom/wavedrom.github.io/blob/master/init.js) (Editor initialization), [`editor.html`](https://github.com/wavedrom/wavedrom.github.io/blob/master/editor.html) (Editor page), [`impress.html`](https://github.com/wavedrom/wavedrom.github.io/blob/master/impress.html) (Presentation page)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_authoring["Diagram authoring"]
  node_editor_page["Editor page<br/>[editor.html]"]
  node_editor_logic["Editor controls<br/>[editor.js]"]
  node_code_editor["CodeMirror"]
  node_editor_init["Editor initialization<br/>[init.js]"]
  node_wavejson["WaveJSON format<br/>[wavedrom.json]"]
  node_local_state[("Local waveform")]
end

subgraph group_rendering["Diagram rendering"]
  node_engine["WaveDrom engine"]
  node_default_skin["Default skin<br/>[default.js]"]
  node_dark_skin["Dark skin<br/>[dark.js]"]
  node_lowkey_skin["Lowkey skin<br/>[lowkey.js]"]
  node_narrow_skin["Narrow skin<br/>[narrow.js]"]
  node_narrower_skin["Narrower skin<br/>[narrower.js]"]
  node_narrowerer_skin["Narrower skin<br/>[narrowerer.js]"]
end

subgraph group_export["File and export"]
  node_export_files["Export files"]
  node_desktop_files["Desktop files"]
end

subgraph group_presentation["Presentation"]
  node_presentation_page["Presentation page<br/>[impress.html]"]
  node_presentation_runtime["Presentation runtime<br/>[impress.js]"]
end

node_user(("Editor user"))

node_user -->|"opens editor"| node_editor_page
node_editor_page -->|"hosts controls"| node_editor_logic
node_editor_logic -->|"refreshes diagram"| node_engine
node_editor_page -->|"uses format"| node_wavejson
node_editor_init -->|"creates editor"| node_code_editor
node_editor_init -->|"refreshes diagram"| node_editor_logic
node_editor_init -->|"stores waveform"| node_local_state
node_editor_logic -->|"exports SVG PNG JSON"| node_export_files
node_editor_logic -->|"reads and writes"| node_desktop_files
node_engine -.-> node_default_skin
node_engine -.-> node_dark_skin
node_engine -.-> node_lowkey_skin
node_engine -.-> node_narrow_skin
node_engine -.-> node_narrower_skin
node_engine -.-> node_narrowerer_skin
node_user -.->|"views slides"| node_presentation_page
node_presentation_page -.->|"runs presentation"| node_presentation_runtime

click node_editor_page "https://github.com/wavedrom/wavedrom.github.io/blob/master/editor.html"
click node_editor_logic "https://github.com/wavedrom/wavedrom.github.io/blob/master/editor.js"
click node_code_editor "https://github.com/wavedrom/wavedrom.github.io/blob/master/scripts/codemirror-compressed.js"
click node_editor_init "https://github.com/wavedrom/wavedrom.github.io/blob/master/init.js"
click node_wavejson "https://github.com/wavedrom/wavedrom.github.io/blob/master/schema/wavedrom.json"
click node_default_skin "https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/default.js"
click node_dark_skin "https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/dark.js"
click node_lowkey_skin "https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/lowkey.js"
click node_narrow_skin "https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/narrow.js"
click node_narrower_skin "https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/narrower.js"
click node_narrowerer_skin "https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/narrowerer.js"
click node_presentation_page "https://github.com/wavedrom/wavedrom.github.io/blob/master/impress.html"
click node_presentation_runtime "https://github.com/wavedrom/wavedrom.github.io/blob/master/impress/impress.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_editor_page,node_editor_logic,node_code_editor,node_editor_init,node_wavejson,node_local_state,node_user toneBlue
class node_engine,node_default_skin,node_dark_skin,node_lowkey_skin,node_narrow_skin,node_narrower_skin,node_narrowerer_skin toneAmber
class node_export_files,node_desktop_files toneMint
class node_presentation_page,node_presentation_runtime toneRose
```

## Components

### Diagram authoring

- [Editor page](https://github.com/wavedrom/wavedrom.github.io/blob/master/editor.html): `editor.html`
- [Editor controls](https://github.com/wavedrom/wavedrom.github.io/blob/master/editor.js): `editor.js`
- [CodeMirror](https://github.com/wavedrom/wavedrom.github.io/blob/master/scripts/codemirror-compressed.js): `scripts/codemirror-compressed.js`
- [Editor initialization](https://github.com/wavedrom/wavedrom.github.io/blob/master/init.js): `init.js`
- [WaveJSON format](https://github.com/wavedrom/wavedrom.github.io/blob/master/schema/wavedrom.json): `schema/wavedrom.json`
- **Local waveform**

### Diagram rendering

- **WaveDrom engine**
- [Default skin](https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/default.js): `skins/default.js`
- [Dark skin](https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/dark.js): `skins/dark.js`
- [Lowkey skin](https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/lowkey.js): `skins/lowkey.js`
- [Narrow skin](https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/narrow.js): `skins/narrow.js`
- [Narrower skin](https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/narrower.js): `skins/narrower.js`
- [Narrower skin](https://github.com/wavedrom/wavedrom.github.io/blob/master/skins/narrowerer.js): `skins/narrowerer.js`

### File and export

- **Export files**
- **Desktop files**

### Presentation

- [Presentation page](https://github.com/wavedrom/wavedrom.github.io/blob/master/impress.html): `impress.html`
- [Presentation runtime](https://github.com/wavedrom/wavedrom.github.io/blob/master/impress/impress.js): `impress/impress.js`

### Other components

- **Editor user**

## Connections

- Editor user → Editor page: opens editor (evidence: `README.md`)
- Editor page → Editor controls: hosts controls (evidence: `README.md`)
- Editor controls → WaveDrom engine: refreshes diagram (evidence: `editor.js`)
- Editor page → WaveJSON format: uses format (evidence: `README.md`)
- Editor initialization → CodeMirror: creates editor (evidence: `init.js`)
- Editor initialization → Editor controls: refreshes diagram (evidence: `init.js`)
- Editor initialization → Local waveform: stores waveform (evidence: `init.js`)
- Editor controls → Export files: exports SVG PNG JSON (evidence: `editor.js`)
- Editor controls → Desktop files: reads and writes (evidence: `editor.js`)
- WaveDrom engine → Default skin
- WaveDrom engine → Dark skin
- WaveDrom engine → Lowkey skin
- WaveDrom engine → Narrow skin
- WaveDrom engine → Narrower skin
- WaveDrom engine → Narrower skin
- Editor user → Presentation page: views slides
- Presentation page → Presentation runtime: runs presentation
