chordsketch-render-html 0.2.0

HTML renderer for ChordPro documents
Documentation
  • Coverage
  • 100%
    9 out of 9 items documented0 out of 8 items with examples
  • Size
  • Source code size: 153.95 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 3.29 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 59s Average build duration of successful builds.
  • all releases: 38s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • koedame/chordsketch
    0 0 19
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • unchidev

chordsketch-render-html

HTML renderer for ChordPro documents. Produces self-contained HTML5 documents with chords positioned above lyrics.

Part of the ChordSketch project.

Usage

use chordsketch_core::parser::parse;
use chordsketch_render_html::render_song;

let input = "{title: Amazing Grace}\n[G]Amazing [G7]grace";
let song = parse(input).unwrap();
let html = render_song(&song);

Features

  • Self-contained HTML5 output
  • Chord positioning above lyrics
  • Metadata display (title, subtitle, artist)
  • Section styling
  • HTML escaping for user-provided text content (note: delegate environments such as {start_of_svg} emit raw HTML by design; use a Content Security Policy when rendering untrusted input)

Documentation

API documentation on docs.rs

License

MIT