ddoc/lib.rs
1//!
2//! **ddoc** is a markdown based static site generator.
3//!
4//! **Complete documentation at [https://dystroy.org/ddoc](https://dystroy.org/ddoc)**
5//!
6//! ## Usage overview
7//!
8//! Create a directory, then move to it
9//!
10//! ```bash
11//! mkdir website & cd website
12//! ```
13//!
14//! Initialize the site:
15//!
16//! ```bash
17//! ddoc --init
18//! ```
19//!
20//! This creates:
21//!
22//! - a `.gitignore` file, which eases inclusion of your site in a git managed project
23//! - a `ddoc.hjson` file, holding the basic properties and navigation
24//! - a `src` folder, for your markdown files, CSS style sheets and images
25//! - a `plugins` folder, with default plugins
26//!
27//! To build your site, run
28//!
29//! ```bash
30//! ddoc
31//! ```
32//!
33//! This updates a `site` directory, whose content can be sent to your server.
34//!
35//! To test it locally, run
36//!
37//! ```bash
38//! ddoc --serve
39//! ```
40//!
41//! Then have a look at the [documentation](https://dystroy.org/ddoc/setup/) to improve your site.
42//!
43
44mod cli;
45mod compat;
46mod config;
47mod error;
48mod files;
49mod html;
50mod init;
51mod module;
52mod page;
53mod page_path;
54mod page_writer;
55mod project;
56mod resources;
57mod server;
58mod sourced;
59mod statics;
60mod version;
61mod watcher;
62
63pub use {
64 cli::*,
65 compat::*,
66 config::*,
67 error::*,
68 files::*,
69 html::*,
70 init::*,
71 module::*,
72 page::*,
73 page_path::*,
74 page_writer::*,
75 project::*,
76 resources::*,
77 server::*,
78 sourced::*,
79 statics::*,
80 version::*,
81 watcher::*,
82};
83
84#[macro_use]
85extern crate cli_log;