1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
//! # okf: the Open Knowledge Format, in pure Rust
//!
//! A dependency-free implementation of the [Open Knowledge Format (OKF)
//! v0.2][spec], Google's open, human- and agent-friendly format for
//! representing knowledge as a directory of markdown files with YAML
//! frontmatter.
//!
//! This crate is the user-facing entry point of the OKF workspace. It ships
//! the `okf` command-line tool (`cargo install okf`) and re-exports the entire
//! API of the [`okf-core`](https://docs.rs/okf-core) crate, where the
//! specification is implemented, so as a dependency it is used exactly like a
//! plain library:
//!
//! ```no_run
//! use okf::{Bundle, validate_bundle};
//!
//! let bundle = Bundle::load("./my_bundle")?;
//! println!("{} concepts", bundle.len());
//!
//! let report = validate_bundle(&bundle);
//! if report.is_conformant() {
//! println!("conformant OKF v0.2 bundle");
//! }
//! # Ok::<(), okf::BundleError>(())
//! ```
//!
//! See the okf-core documentation for the full model: [`Bundle`], [`Document`],
//! [`Frontmatter`], [`ConceptId`], the provenance/trust/attestation families,
//! and the [`validate_bundle`] conformance checker.
//!
//! [spec]: https://github.com/GoogleCloudPlatform/open-knowledge-format/blob/main/SPEC.md
/// Compiles and runs the `README.md` examples as doctests.
///
/// `cfg(doctest)` means this item exists only while `cargo test` collects
/// doctests, so it never reaches the public API or the rendered documentation.
/// Without it the README's Rust blocks would be prose that nothing checks.
;
// Hidden from the documented API: the CLI implementation is exposed only so
// the okf binary and the cargo-okf subcommand can share it, and carries no
// stability promise for library consumers.
pub use *;
pub use *;