ddoc 0.18.0

doc site generator
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

//!
//! **ddoc** is a markdown based static site generator.
//!
//! **Complete documentation at [https://dystroy.org/ddoc](https://dystroy.org/ddoc)**
//!
//! ## Usage overview
//!
//! Create a directory, then move to it
//!
//! ```bash
//! mkdir website & cd website
//! ```
//!
//! Initialize the site:
//!
//! ```bash
//! ddoc --init
//! ```
//!
//! This creates:
//!
//! - a `.gitignore` file, which eases inclusion of your site in a git managed project
//! - a `ddoc.hjson` file, holding the basic properties and navigation
//! - a `src` folder, for your markdown files, CSS style sheets and images
//! - a `plugins` folder, with default plugins
//!
//! To build your site, run
//!
//! ```bash
//! ddoc
//! ```
//!
//! This updates a `site` directory, whose content can be sent to your server.
//!
//! To test it locally, run
//!
//! ```bash
//! ddoc --serve
//! ```
//!
//! Then have a look at the [documentation](https://dystroy.org/ddoc/setup/) to improve your site.
//!

mod cli;
mod compat;
mod config;
mod error;
mod files;
mod html;
mod init;
mod module;
mod page;
mod page_path;
mod page_writer;
mod project;
mod resources;
mod server;
mod sourced;
mod statics;
mod version;
mod watcher;

pub use {
    cli::*,
    compat::*,
    config::*,
    error::*,
    files::*,
    html::*,
    init::*,
    module::*,
    page::*,
    page_path::*,
    page_writer::*,
    project::*,
    resources::*,
    server::*,
    sourced::*,
    statics::*,
    version::*,
    watcher::*,
};

#[macro_use]
extern crate cli_log;