vimwiki

此 crate 代表 vimwiki 语言的定义和解析支持。它被分割出来，以便其他人可以在此基础上构建并编写自己的工具。

目前不支持 Windows！请参阅问题 #89。

使用方法

将此添加到您的 Cargo.toml

[dependencies]
vimwiki = "0.1"

示例

use vimwiki::{Language, elements::*};

// Load some language as a string
let language = Language::from_vimwiki_str(r#"
= My Header =
///
Some paragraph with *decorations* and [[links]] that you would normally
see in a vimwiki file.
"#);

// Parse the input as a page using vimwiki format
let page: Page = language.parse().unwrap();

功能

默认情况下，没有启用任何功能，但以下功能可用

• html: 如果指定，将支持将 vimwiki 元素转换为 html。
• macros: 如果指定，将引入 vimwiki_macros 以在编译时公开顶层宏函数来解析和生成 vimwiki 元素。
• timekeeper: 如果指定，所有解析逻辑都通过一个静态分配的 HashMap 运行，该 HashMap 记录了解析各种元素所需的时间，并以人类可读的格式打印结果。这在内部性能优化中非常有用。

许可证

本项目许可协议为以下之一

Apache License，版本 2.0，（LICENSE-APACHE 或 apache-license）MIT 许可证（LICENSE-MIT 或 mit-license），您可选择。