Skip to content

[Feature]: Export the wiki visualizer as a static site #587

Description

@Aveek-Saha

Summary

Add a static-export mode for the native OpenWiki visualizer so generated wiki graphs can be published through GitHub Pages, MkDocs, and other static hosting.

Motivation

openwiki visualize currently runs a loopback-only HTTP server. Its browser client loads graph data from /api/graph and uses /events for SSE-based live reload, so it cannot be deployed as static documentation output.

Teams that publish OpenWiki-generated documentation must currently use a separate renderer or build their own adapter. A native export would allow the visualization to live beside the generated Markdown without a persistent application server.

Proposed Solution

Add an explicit export mode, for example:

openwiki visualize openwiki --export docs/openwiki-visualizer

The command could create a static directory:

docs/openwiki-visualizer/
  index.html
  client.js
  client-lib.js
  graph.json

Alternatives Considered

Use an external OpenWiki/OKF renderer: this works, but creates a second implementation that must track OpenWiki’s output format and visualizer capabilities.

Additional Context

I am willing to submit a PR for a directory-based static export.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions