saneyaml documentation

Serde-first YAML for Rust, with real YAML 1.2 semantics. Read this as a hosted guide at https://jskoiz.github.io/saneyaml/, or start with Getting started in the repo and open a topic page when you hit it.

Learn the basics

• Getting started — install, parse into a struct, emit. ~5 minutes.
• Cookbook — copy-paste recipes for the common tasks.

Topic guides

• Schema modes — YAML 1.2 vs 1.1, and why NO stays the string "NO".
• Diagnostics — line/column, key paths, and source carets in errors.
• Untrusted input — resource limits for hostile YAML.
• Editing files — change values in place without losing comments, anchors, or ordering.
• Streaming — pull events/documents with bounded memory.

Migrating

• From serde_yaml — drop-in alias and a call-site cookbook.

Reference

• Compatibility — scalar resolution table, divergences, threat model.
• Architecture — crate layout and design decisions.
• Benchmarks — throughput and memory vs other crates.
• API reference (docs.rs) — full generated docs.

Project

Changelog · Security policy · Contributing · License