Bibliothèque

KatanA Document Viewer

Une bibliothèque Rust pour intégrer l'aperçu de documents et l'export HTML, PDF et image dans une application, avec des données indépendantes du framework UI.

Développeurs Rust qui intègrent un viewer de documents ou l'export HTML, PDF et image

01

Capacités implémentées

API pour les snapshots de documents, les données d'export et les diagnostics

Références

Connexion de la structure Markdown au rendu de diagrammes de KRR

Références

02

Premiers pas

  1. Récupérez le dépôt et vérifiez dans le README les prérequis de runtime et de polices.
  2. Utilisez l'exemple export_debug avec un fichier Markdown et un dossier de sortie, puis examinez le document généré.

Préparez Rust et les outils de développement nécessaires, puis consultez le README lié pour les prérequis avant l'installation. Les exemples indiquent un point de départ et ne garantissent pas le fonctionnement dans tous les environnements.

Références
sh
git clone https://github.com/HiroyukiFuruno/katana-document-viewer.git
cd katana-document-viewer
cargo run -p katana-document-viewer --example export_debug -- README.md ./export-output

01 / KDV

Cas d'utilisation

Une base commune pour l'affichage et l'export

KDV traite Markdown comme cadre documentaire, état et diagnostics sans le lier à l'UI de l'application. Le même pipeline de rendu peut produire HTML, PDF, PNG et JPEG, en partageant la frontière entre affichage et export.

Préparer l'export de documents avec diagrammes

KDV construit le Markdown contenant diagrammes ou formules et délègue le rendu des diagrammes à KRR, tout en conservant les sémantiques non prises en charge comme diagnostics et source brute. Les entrées que l'affichage ne comprend pas restent disponibles pour l'étape suivante au lieu d'être ignorées.

02 / KDV

Flux entrée-sortie

  1. Normaliser l'entrée

    Lisez le fichier, uniformisez CRLF/CR en LF, puis normalisez les fences Markdown avec MarkdownFenceNormalizer. Définissez dans la source l'URI, le source kind, la revision et le contenu.

  2. Créer le snapshot et le build graph

    Structurez Markdown avec KatanaMarkdownModel::parse et créez un snapshot avec DocumentSnapshotFactory::from_kmm. Passez le snapshot, le markdown export profile et le theme à BuildRequest, puis produisez un BuildGraph avec diagnostics via ForgePipeline::build.

  3. Conserver les artefacts et diagnostics

    Passez le build graph à ForgePipeline::export pour créer l'artefact du format demandé, puis sortez build graph, coverage et summary TOML avec lui. L'exemple d'export échoue si l'artefact est vide afin de ne pas livrer un résultat incomplet.

03 / KDV

API et CLI principales

DocumentSnapshotFactory — Instantané du document
Associe le document KMM et DocumentSource pour créer le DocumentSnapshot consommé par viewer et forge. Le snapshot dépend aussi de l'URI et de la revision, pas seulement du texte.
ForgePipeline::build — Construction du graphe
Traite le snapshot, le BuildProfile et le theme de BuildRequest, puis renvoie un BuildGraph contenant snapshot documentaire, profile, diagnostics et diagrammes rendus.
ForgePipeline::export — Export des documents
Transforme le build graph, le format et le theme d'ExportRequest en ExportOutput. Les formats sont HTML, PDF, PNG et JPEG, avec artefact et forge diagnostics pour l'étape suivante.
KRR diagram backend — Connexion des diagrammes
Passez DiagramRenderingBackend et KrrDiagramRenderEngine au pipeline pour relier le rendu des diagrammes à la frontière KRR. Cette API ne fait pas posséder à KDV l'UI de l'application ni une autre implémentation de diagrammes.

04 / KDV

Comprendre par un exemple

Construire README et afficher le nombre de nœuds

Ce code lit README.md, le normalise, le parse, crée un snapshot, puis construit un BuildGraph avec le profil markdown export avant d'afficher nodes. Il reprend uniquement la partie build de l'exemple public export_debug : il n'enregistre aucun fichier et n'exporte pas les quatre formats.

rust
use katana_document_viewer::{
    BuildProfile, BuildRequest, DiagramRenderingBackend, DocumentSnapshotFactory,
    DocumentSource, ForgePipeline, KrrDiagramRenderEngine, MarkdownFenceNormalizer,
    SourceKind, SourceRevision, SourceUri,
};
use katana_markdown_model::{KatanaMarkdownModel, MarkdownInput};
use std::fs;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let path = "README.md";
    let content = MarkdownFenceNormalizer::normalize(&fs::read_to_string(path)?);
    let source = DocumentSource {
        uri: SourceUri(format!("file://{path}")),
        kind: SourceKind::Markdown,
        revision: SourceRevision("local".to_string()),
        content: content.clone(),
    };
    let document = KatanaMarkdownModel::parse(MarkdownInput::from_content(path, content))?;
    let snapshot = DocumentSnapshotFactory::from_kmm(source, document);
    let request = BuildRequest {
        snapshot,
        profile: BuildProfile::markdown_export(),
        theme: Default::default(),
    };
    let pipeline = ForgePipeline::new(DiagramRenderingBackend::new(KrrDiagramRenderEngine));
    let graph = pipeline.build(&request)?;
    println!("nodes={}", graph.snapshot.document.nodes.len());
    Ok(())
}

05 / KDV

Intégration et limites

Garder le backend UI hors de KDV

KDV ne dépend ni d'egui ni d'eframe et n'expose pas les types KUC dans son API publique. Une application de niveau supérieur comme KatanA coordonne la synchronisation viewer/editor ; KDV reste centré sur les frontières document/viewer/export.

L'adopter comme scaffolding

Le README public décrit un scaffolding : v0.1.0 fournit une fondation artifact/forge/export indépendante de l'UI. Ne comblez pas les parser gaps de KMM par un reparse et ne présentez pas les sémantiques non prises en charge par KRR comme des fonctions achevées.

Références

Cette présentation repose sur les dépôts publics au moment de l'examen. Vérifiez l'implémentation et l'utilisation dans les commits figés liés.

DépôtFichier README99371a97dbc5
Références · KDV
Tous les produits