Questions & Answers

Frequently Asked Questions

Technical guidance on NucleusFlow's three-stage Rust architecture, supported formats, microsecond benchmarks, and dual licensing.

Showing 8 of 8 questions
Architecture Can I use NucleusFlow as a Rust library inside my own application, or is it only a CLI?

Both. Unlike monolithic static site binaries such as Hugo or Zola, NucleusFlow is published on Crates.io as both a library crate (nucleusflow) and a CLI binary. You can import ContentProcessor, HandlebarsRenderer, HtmlGenerator, or the top-level NucleusFlow orchestrator directly into your Rust services.

Toolchain What is the Minimum Supported Rust Version (MSRV)?

NucleusFlow requires Rust 1.89.0 or newer (2021 Edition). This floor is verified in CI and enforced at build time by Cargo.toml and build.rs.

Concurrency Is NucleusFlow thread-safe for concurrent rendering?

Yes. Every core stage implements Send + Sync and the blanket Shareable trait (.into_shared()), wrapping instances in Arc<parking_lot::RwLock<Self>> so compiled Handlebars templates and assets can be shared safely across worker threads.

Markdown Which Markdown extensions and frontmatter formats are supported?

MarkdownProcessor parses CommonMark plus GitHub Flavored Markdown (GFM tables, footnotes, and strikethrough) via pulldown-cmark 0.13.5, and extracts --- fenced YAML 1.2 frontmatter via noyalib 0.0.58.

Templating Why does NucleusFlow use Handlebars (.hbs) templates?

Handlebars enforces logic-less templates with clear separation between presentation layouts and Rust business logic, while supporting partials, custom TemplateHelper functions, and strict variable checking via the battle-tested handlebars 6.2 crate.

HTML5 Does NucleusFlow validate and minify HTML5 output automatically?

Yes. HtmlGenerator verifies structural HTML5 tag balance (accounting for void elements like img and meta as well as optional-closing elements like p and li) and minifies HTML, inline CSS, and inline JS in ~8.1 µs using minify-html 0.18.1.

Safety Does NucleusFlow contain any unsafe Rust code?

No. Both the library crate and CLI binary enforce #![forbid(unsafe_code)] at the crate root per ADR-0001.

Licensing How is NucleusFlow licensed?

NucleusFlow and its documentation are dual-licensed under your choice of the Apache License, Version 2.0 (LICENSE-APACHE) or the MIT License (LICENSE-MIT).

No matching questions found

Try searching for broader terms such as “Handlebars”, “YAML”, “MSRV”, or “CLI”.

Have a question not listed here?

Explore the documentation guides, open an issue on GitHub, or contact the maintainer directly.