NMD 核心

nmd-core 是 NMD 的核心。它可以用来加载和构建 NMD 文件或文档。

如果您想了解更多关于 NMD 的信息，请点击这个 链接。

要开始使用，请将 nmd-core 添加到您的项目中

cargo add nmd-core

let dossier_path = PathBuf::from(...)

let format = OutputFormat::Html;

let codex = Codex::of_html(CodexConfiguration::default());


// === Load ===

let loader_configuration = LoaderConfiguration::default();

let mut dossier = Loader::load_dossier_from_path_buf(dossier_path, &codex, &loader_configuration)?;


// === Compile ===

let compilation_configuration = CompilationConfiguration::default();

let compilation_configuration_overlay = Arc::new(RwLock::new(CompilationConfigurationOverLay::default()));

Compiler::compile_dossier(&mut dossier, &format, &codex, &compilation_configuration, compilation_configuration_overlay)?;


// === Assemble ===

let html_assembler_configuration = HtmlAssemblerConfiguration::default();

let artifact = HtmlAssembler::assemble_dossier(&dossier, &html_assembler_configuration)?;


// === Dump === 

let dump_configuration = DumpConfiguration::new(...);

artifact.dump(&dump_configuration)?;

文档

完整文档

开发

开发 清单

NMD 语法

NMD 标准语法

[!WARNING] NMD 语法仍在开发中，您可以通过以下 贡献指南 来贡献力量！

作者

Nicola Ricciardi

贡献

如果您想为 NMD 编译器的开发做出贡献，请遵循 贡献指南。

许可协议

本项目采用 GNU 通用公共许可证 v3.0 许可 - 有关详细信息，请参阅 LICENSE 文件。