mant-core 0.5.0

Structured manual and Markdown document engine used by ManT
Documentation 
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
56
57
58
59
60
61
62
63
64
65

//! Manual source, query, and output engine independent from its process hosts.

mod catalog;
mod definitions;
mod documents;
mod executable;
mod inline;
#[cfg(unix)]
mod mandoc;
mod markdown;
mod output;
mod projection;
mod query;
mod search;
mod source;
mod tldr;

pub use catalog::{
    AvailableDocument, AvailableDocumentKind, AvailableDocumentOrigin, list_available_documents,
};
pub use documents::{
    RegisteredDocument, RegisteredDocumentOrigin, find_registered_document,
    list_registered_documents,
};
#[cfg(unix)]
pub use mandoc::{lower_mandoc_document, parse_manual_source};
pub use markdown::{MarkdownParseError, ParsedMarkdown, TldrDirectiveError, parse_markdown};
pub use output::{
    MarkdownOptions, render_excerpt_json, render_excerpt_markdown,
    render_excerpt_markdown_with_options, render_excerpt_text, render_markdown,
    render_markdown_with_options, render_outline_json, render_outline_markdown,
    render_outline_text, render_query_json, render_query_man, render_query_text,
    render_search_json, render_search_markdown, render_search_text, render_update_json,
};
pub use projection::{ProjectionError, build_outline, build_outline_with_detail, select_excerpt};
pub use query::{
    MAX_MARKDOWN_BYTES, QueryError, QueryPolicy, query, query_markdown_text, query_with_policy,
};
pub use search::{SearchError, search_query, validate_search_query};
pub use source::{
    CommandOutput, LocateError, ManualIndex, ManualPage, ManualRequest, discover_manual_roots,
    locate_manual_source, locate_manual_source_in, system_manual_index,
};
pub use tldr::{
    HostPlatform, TldrCacheError, TldrPageLocation, TldrParseError, TldrUpdateError,
    get_system_tldr_cache_dirs, get_tldr_cache_dir, get_tldr_languages, get_tldr_platforms,
    get_tldr_read_cache_dirs, normalize_tldr_topic, parse_tldr_command, parse_tldr_page,
    read_cached_tldr_page, update_tldr_cache,
};

/// Reports the native contract version through the engine layer.
#[must_use]
pub const fn native_api_version() -> &'static str {
    mant_ast::NATIVE_API_VERSION
}

#[cfg(test)]
mod tests {
    use super::native_api_version;

    #[test]
    fn exposes_the_ast_contract_version() {
        assert_eq!(native_api_version(), "4");
    }
}