Skip to content

Ribalta

Write the text. The theme takes care of the visuals.
--- {align=center}
Quarterly report {.kicker}
# We grew [38%]{color=yellow} this quarter
Recurring revenue above target for the third month in a row. {.lead}

Each --- line starts a page. Headings, lists and emphasis are written as in Markdown; ::: blocks build columns, cards and charts; attributes in {…} adjust whatever you need. Colors, fonts and spacing come from the theme, by name.

  • Guides: text, page sizes, layouts, styling, themes, header and footer, components, data, interactivity, step-by-step reveal, charts and images.
  • Reference: the whole syntax, attributes, blocks, themes, icons and error messages.
PackageWhat for
@ribaltalang/compilerCompiles the text in the browser or in Node.js (WebAssembly) and returns the document as JSON with its diagnostics.
@ribaltalang/rendererDraws the document with React.
@ribaltalang/playerNavigation, steps, state, timers, keyboard and sounds of an interactive document.
@ribaltalang/codemirrorHighlighting, completion and errors in CodeMirror 6.
ribaltaThe compiler as a Rust library.
ribalta-cliThe ribalta command: checks, formats, shows the route map and serves as a language server for editors.
VS Code extensionHighlighting, errors as you type, completion, go to definition and formatting.

The format of the compiled document is described in IR.md.