Bibliothek
KatanA Render Runtime
Eine Rust-Bibliothek und CLI, die Diagramm- und TeX-Mathematikquellen in SVG umwandeln und gemeinsame Ein-/Ausgabe-APIs für Ergebnisse und Diagnosen bietet.
Rust-Entwickler, die SVG-Rendering für Diagramme und Mathematik einbetten
01
Implementierte Fähigkeiten
02
Erste Schritte
- Bereiten Sie Rust und die im README beschriebenen Laufzeit-Assets vor und installieren Sie die krr-CLI.
- Erstellen Sie eine Mermaid-Eingabedatei und erzeugen Sie mit render ein SVG.
Bereiten Sie Rust und die erforderlichen Entwicklungstools vor und prüfen Sie vor der Installation die Umgebungsanforderungen im verknüpften README. Beispiele zeigen einen Einstieg und garantieren keinen Betrieb in jeder Umgebung.
Belegecargo install katana-render-runtime-cli
printf 'graph TD\n A-->B\n' > sample.mmd
krr mermaid render --input sample.mmd --output sample.svg01 / KRR
Anwendungsfälle
Konvertieren Sie Diagramme und Formeln im selben Vertrag in SVG
Übergeben Sie Diagrammquellen von Mermaid, ZenUML, Draw.io, PlantUML und TeX von MathJax als typisierte RenderInputs. Da KRR jede Laufzeit auswählt und ein RenderOutput zurückgibt, das SVG, Abmessungen, ViewBox, Laufzeitinformationen, Warnungen/Fehler und Cache-Fingerabdrücke enthält, können Vorschauen und Dokumentanzeiger Rendering-Ergebnisse verarbeiten, ohne Implementierungen für jeden Abbildungstyp implementieren zu müssen.
Diagnosevorschau der Formeleingabe
MathJaxRenderer konvertiert reguläre Inline-TeX- und Anzeigeformeln in SVG, behält die Eingabezeichenfolge bei und gibt den Grund in „diagnostics.errors“ bei deaktiviertem TeX oder deinstallierten Laufzeiten zurück. Es ist geeignet, die ursprüngliche Quelle und Diagnose auf dem Bearbeitungsbildschirm anzuzeigen, ohne dass ein Zeichnungsfehler zu einem Fehler des gesamten Bildschirms führt. Im öffentlichen Test haben wir SVG und Dimensionen im normalen System sowie Originaleingabe, 0-Dimensionen und nicht leere Fehler im abnormalen System bestätigt.
02 / KRR
Ablauf von Eingabe zu Ausgabe
Geben Sie Quelle und Typ ein
Der Aufrufer legt RenderInput mit RenderKind, klassifizierter Quelle, RenderConfig, RenderPolicy und RenderContext fest. KRR akzeptiert keine Markdown-ASTs und ist für die direkte Verarbeitung von Diagrammen oder TeX-Strings verantwortlich.
Auflösen von Laufzeiten und Themen
RuntimePathResolver priorisiert den angegebenen runtime path und löst bei Nichtangabe gebündelte Assets in Mermaid, Draw.io und MathJax sowie den versionierten cache path von PlantUML auf. PlantUML liest Theme und cache directory aus vendor_config und gibt bei ungültigen Einstellungen RenderError zurück.
Erhalten Sie SVG und Diagnose
Der Rückgabewert von Renderer::render ist RenderOutput. Gibt SVG und positive Dimensionen für normale Diagramme und Formeln zurück und gibt RenderError oder Backend-definierte Rohquellen und Diagnosen für Eingabefehler oder Laufzeitabwesenheit zurück, sodass Benutzer Warnungen und Fehler anzeigen und aufzeichnen können.
03 / KRR
Wichtige APIs und CLI
Renderer::render — Render-Vertrag- Der einheitliche Eintrag ist Renderer::render(&RenderInput). Wenn die Kombination aus RenderKind und Quelle nicht mit dem Backend übereinstimmt, ist es UnsupportedKind, und wenn die Laufzeitauflösung fehlschlägt, wird es RenderError wie RuntimeResolution sein.
RenderOutput — Ergebnisdaten- Die Ausgabe umfasst svg, width, height, view_box, runtime, profile, diagnostics und cache_fingerprint. Sie erhalten nicht nur eine SVG-Zeichenfolge, sondern auch die Anzeigedimensionen und Metadaten, die für Entscheidungen zur Wiederverwendung erforderlich sind.
krr render — CLI-Einstieg- Die CLI verarbeitet Eingabedateien in der Form krr mermaid render, krr drawio render, krr plantuml render. --output, --runtime und PlantUMLs --theme, --theme-mode und --cache-dir können angegeben werden. Wenn die Ausgabedatei weggelassen wird, werden die Ergebnisse auf der Standardausgabe ausgegeben.
Vergleichs-/Diagnosebefehle- reference-update, compare und bench arbeiten mit dem fixture directory. Der Standardwert für compare minimum score beträgt 99.0. Die Befehle eignen sich als Regressionstest-Leitfaden für die Produktintegration; sie sind jedoch ein Qualitätsvergleichsmechanismus und keine Garantie für die Ausführungsleistung.
04 / KRR
An einem Beispiel verstehen
Behandeln Sie ungültige Eingaben in MathJax mit Diagnose
Lösen Sie auf der Rust-Seite die MathJax-Laufzeit vom RuntimePathResolver auf und übergeben Sie den RenderInput an den MathJaxRenderer. Wenn die Eingabe „\not_a_real_mathjax_command“ ist, gibt render weiterhin die Ausgabe zurück, „svg“ ist die ursprüngliche Eingabe, „Breite“ und „Höhe“ sind 0 und „diagnostics.errors“ ist nicht leer. Ein normales E = mc^2 ergibt ein SVG, eine ViewBox und eine positive Breite und Höhe.
use katana_render_runtime::{
MathJaxRenderer, RenderConfig, RenderContext, RenderInput, RenderKind,
RenderPolicy, Renderer, RuntimePathResolver,
};
fn main() -> Result<(), Box<dyn std::error::Error>> {
let runtime = RuntimePathResolver::resolve(RenderKind::MathJax, None)?;
let renderer = MathJaxRenderer::with_runtime_path(runtime);
let input = RenderInput {
kind: RenderKind::MathJax,
source: r"\not_a_real_mathjax_command".to_string(),
config: RenderConfig::default(),
policy: RenderPolicy::default(),
context: RenderContext::default(),
};
let output = renderer.render(&input)?;
println!("svg={} errors={:?}", output.svg, output.diagnostics.errors);
Ok(())
}05 / KRR
Integration und Grenzen
Voraussetzungen für die Einführung
Der öffentliche Arbeitsbereich ist Rust 1.95.0, Edition 2024, und die Laufzeit-Assets verwalten Versionen und Prüfsummen von Mermaid, Draw.io, MathJax, PlantUML usw. Sie können wählen, ob Sie das Standard-Asset verwenden oder die Laufzeit durch einen expliziten Pfad oder eine Umgebungsvariable ersetzen möchten.
Verantwortungsgrenze
KRR ist für die Laufzeitzeichnung von klassifizierten Zahlen und TeX-Quellen verantwortlich. Wir sind nicht verantwortlich für die Markdown-AST-Analyse, den HTML-/PDF-/PNG-/JPG-Dokumentexport, die Viewer-/Editor-Benutzeroberfläche, die KDV-Paginierung und den Dokumentenexport, daher werden diese auf der oberen Modell-/Viewer-/App-Seite kombiniert.
Belege
Diese Übersicht basiert auf den öffentlichen Repositories zum Zeitpunkt der Prüfung. Implementierung und Nutzung können in den verknüpften fixierten Commits geprüft werden.