italic 0.2.4

A static site generator for your digital garden
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

use crate::config::Config;
use crate::doc::Doc;
use crate::doc_index::DocIndex;
use crate::site_data::SiteData;
use crate::tera_env::build_template_env;
use anyhow::{Context, Result};
use rayon::prelude::*;
use std::path::PathBuf;
use std::sync::Arc;
use tera::Tera;

/// Render every source doc (read-only, from the frozen `classification`) and
/// every archive-emitted page into its final output, returning
/// `(output_path, content)` pairs for [`write::run`](super::write::run).
///
/// The env's `collection()`/`taxonomy()`/`backlinks` functions read the frozen
/// classification (source docs only — archive pages are absent by design).
/// Rendering is read-only: source docs are never mutated, so no clone of the
/// corpus is needed; archive pages are owned and consumed here.
pub fn run(
    config: &Config,
    site_data: &SiteData,
    classification: &Arc<DocIndex>,
    archive_docs: Vec<Doc>,
) -> Result<Vec<(PathBuf, String)>> {
    let env = build_template_env(config, classification.clone())?;

    // `Tera::render` takes `&self`, so the env is shared across Rayon workers by
    // reference. Each doc renders independently into its own output pair.
    let mut outputs: Vec<(PathBuf, String)> = classification
        .par_docs()
        .map(|doc| render(&env, site_data, doc))
        .collect::<Result<Vec<_>>>()?;
    let archive_outputs: Vec<(PathBuf, String)> = archive_docs
        .par_iter()
        .map(|doc| render(&env, site_data, doc))
        .collect::<Result<Vec<_>>>()?;
    outputs.extend(archive_outputs);
    Ok(outputs)
}

/// Render one doc to `(output_path, final content)`. A doc with no `template`
/// keeps its markup-phase content verbatim; otherwise its template is rendered
/// with the doc as `page` (plus `pagination`/`term` for archive pages).
fn render(env: &Tera, site_data: &SiteData, doc: &Doc) -> Result<(PathBuf, String)> {
    let Some(template_name) = doc.template.as_deref() else {
        return Ok((doc.output_path.clone(), doc.content.clone()));
    };

    let mut ctx = tera::Context::new();
    ctx.insert("page", doc);
    ctx.insert("site", &site_data.site);
    ctx.insert("data", &site_data.data);
    if let Some(pagination) = doc.data.get("pagination") {
        ctx.insert("pagination", pagination);
    }
    if let Some(term) = doc.data.get("term") {
        ctx.insert("term", term);
    }
    let content = env.render(template_name, &ctx).with_context(|| {
        format!(
            "rendering template `{}` for {}",
            template_name,
            doc.id_path.display()
        )
    })?;
    Ok((doc.output_path.clone(), content))
}