docket 0.6.1

Simple markdown to HTML documentation rendering
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

use crate::search::TermFrequenciesIndex;
use std::borrow::Cow;
use std::io::{self, Write};

/// Defines a Renderable component
///
/// Renderables can be consumed by the `Renderer` and used to write
/// HTML out to disk. This abstracts over standard `Page` instances
/// and the index page.
pub trait Renderable {
    /// Get the slug of the page
    ///
    /// This should be suitable for use in a URI.
    fn get_slug(&self) -> String;

    /// Get the tilte of the page, so that rendering can place it in
    /// the <head>
    fn get_title(&self) -> Cow<'_, str>;

    /// Write the heading to the output file.
    fn write_header<T: Write>(&self, f: &mut T, title: &str) -> io::Result<()>;

    /// Write the body to the output file.
    fn write_body<T: Write>(&self, _: &mut T) -> io::Result<()>;

    /// Path from this renderbabel to the Root
    fn path_to_root(&self) -> Cow<'_, str>;

    // Get the search index for this renderable, if any.
    fn get_search_index(&self) -> Option<TermFrequenciesIndex>;
}