mdstore 1.2.0

A file-based storage engine that stores structured data as Markdown files with YAML frontmatter
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Slug-based document storage example.
//!
//! Demonstrates using mdstore for documentation with slug identifiers
//! (human-readable IDs derived from titles).
//!
//! Run with: cargo run --example slug_docs

use mdstore::config::IdStrategy;
use mdstore::{CreateOptions, Filters, TypeConfig, TypeFeatures};
use std::collections::HashMap;
use std::path::Path;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let base = Path::new(env!("CARGO_MANIFEST_DIR")).join("examples/output/slug_docs");
    if base.exists() {
        tokio::fs::remove_dir_all(&base).await?;
    }
    let type_dir = base.join("docs");

    // Minimal config -- no status, priority, or display numbers
    let config = TypeConfig {
        name: "Doc".to_string(),

        identifier: IdStrategy::Slug,
        features: TypeFeatures::default(),
        statuses: Vec::new(),
        default_status: None,
        priority_levels: None,
        custom_fields: Vec::new(),
    };

    // Create docs -- IDs are auto-generated from titles
    let doc1 = mdstore::create(
        &type_dir,
        &config,
        CreateOptions {
            title: "Getting Started".to_string(),
            body: "Welcome to the project!\n\n## Installation\n\nRun `cargo add mdstore`."
                .to_string(),
            id: None,
            status: None,
            priority: None,
            tags: None,
            projects: None,
            custom_fields: HashMap::new(),
            comment: None,
        },
    )
    .await?;
    println!("Created: {} (id: {})", doc1.title, doc1.id);

    let doc2 = mdstore::create(
        &type_dir,
        &config,
        CreateOptions {
            title: "API Reference".to_string(),
            body: "Full API documentation for mdstore.".to_string(),
            id: None,
            status: None,
            priority: None,
            tags: None,
            projects: None,
            custom_fields: HashMap::new(),
            comment: None,
        },
    )
    .await?;
    println!("Created: {} (id: {})", doc2.title, doc2.id);

    // You can also provide an explicit slug
    let doc3 = mdstore::create(
        &type_dir,
        &config,
        CreateOptions {
            title: "FAQ".to_string(),
            body: "Frequently asked questions.".to_string(),
            id: Some("faq".to_string()),
            status: None,
            priority: None,
            tags: None,
            projects: None,
            custom_fields: HashMap::new(),
            comment: None,
        },
    )
    .await?;
    println!("Created: {} (id: {})", doc3.title, doc3.id);

    // List all docs
    let all_docs = mdstore::list(&type_dir, Filters::default()).await?;
    println!("\nAll documents:");
    for doc in &all_docs {
        println!("  /{} - {}", doc.id, doc.title);
    }

    // Fetch by slug
    let fetched = mdstore::get(&type_dir, "getting-started").await?;
    println!(
        "\nFetched doc:\n  Title: {}\n  Body: {}",
        fetched.title, fetched.body
    );

    // On-disk, the file is simply: docs/getting-started.md
    let file_path = type_dir.join("getting-started.md");
    let raw = tokio::fs::read_to_string(&file_path).await?;
    println!("\nRaw file content:\n{raw}");

    Ok(())
}