# SiriusMarkdown

> Native Markdown rendering SDK for SwiftUI on macOS, iOS, iPadOS, and visionOS. Supports streaming replies, LaTeX math, Mermaid diagrams, tables, code highlighting, images, and selection.

Distributed as compiled XCFrameworks with public Swift interfaces through Swift Package Manager. Requires Swift 6.3 or later. Licensing eligibility and terms are in the linked license.

## Guides and product information

- [SiriusMarkdown Compare](https://siriusmarkdown.com/compare/download/index.md): Native Swift, Sirius WASM and Pele. One shared source. Three live renderers. Run the comparison on your Mac.
- [Features](https://siriusmarkdown.com/features/index.md): Everything SiriusMarkdown renders, and what readers can do with it: stream, resize, select, copy, search, export, and use it with assistive technologies.
- [How it compares](https://siriusmarkdown.com/compare/index.md): The same math, diagrams, and tables rendered by SiriusMarkdown and other native Swift libraries, with every result checked by hand.
- [Browser integration](https://siriusmarkdown.com/docs/browser/index.md): Host the browser/WASM MVP and understand its platform limits.
- [Getting started](https://siriusmarkdown.com/docs/getting-started/index.md): Add the package and render a static document or a streaming transcript.
- [Streaming](https://siriusmarkdown.com/docs/streaming/index.md): Render replies as they arrive, and put your own views between messages.
- [Configuration and themes](https://siriusmarkdown.com/docs/configuration/index.md): Presets, themes, the renderer protocols you can replace, and diagnostics counters.
- [Policies and safety](https://siriusmarkdown.com/docs/policies/index.md): What links, images, HTML, and remote resources may do by default, and how to change it.
- [Math and diagrams](https://siriusmarkdown.com/docs/math-and-diagrams/index.md): LaTeX math and the sixteen Mermaid diagram types, with the syntax each one accepts.
- [Selection, copy, and export](https://siriusmarkdown.com/docs/selection-and-export/index.md): Selecting across blocks, what goes on the pasteboard, Find, and PDF export.
- [Releases](https://siriusmarkdown.com/releases/index.md): Package release history, with changes to rendering, selection, streaming, and export.
- [Frequently asked questions](https://siriusmarkdown.com/faq/index.md): Answers about installing SiriusMarkdown, supported platforms, streaming, math, diagrams, export, and licensing.
- [License](https://siriusmarkdown.com/license/index.md): License terms, third-party notices, and licensing contact information for SiriusMarkdown.

## Reference

- [API reference](https://siriusmarkdown.com/api/documentation/siriusmarkdown/): Public types and methods.
- [Swift package](https://github.com/mikhutchinson/siriusmarkdown-commercial): Installation, releases, and issue tracker.
- [Full license](https://siriusmarkdown.com/licenses/commercial-sdk-1.0.txt): Commercial SDK License 1.0.

## Optional

- [Complete guide text](https://siriusmarkdown.com/llms-full.txt): The linked product pages and guides in one file.
- [Gallery](https://siriusmarkdown.com/gallery/): Native captures and downloadable Markdown examples.