Skip to main content

fy_docs/
lib.rs

1//! # fy-docs
2//!
3//! `fy-docs` is a Cargo subcommand for building and previewing Typst
4//! specification documents. Install it with `cargo install fy-docs`, then run
5//! `cargo fy-docs` in a project containing `docs/main.typ`.
6//!
7//! The package is a command-line application and deliberately exposes no
8//! library API. See the [README] and [project repository] for usage,
9//! document layout, and release conventions.
10//!
11//! [README]: https://github.com/fengyangsi/fy-docs#readme
12//! [project repository]: https://github.com/fengyangsi/fy-docs