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//!
26//! `/src/css/site.css` is a default CSS file, a very simple one which you can remove, or keep as basis for your own incremental changes to get the layout and look you desire.
27//!
28//! To build your site, run
29//!
30//! ```bash
31//! ddoc
32//! ```
33//!
34//! This updates a `site` directory, whose content can be sent to your server.
35//!
36//! To test it locally, run
37//!
38//! ```bash
39//! ddoc --serve
40//! ```
41//!
42
43mod cli;
44mod config;
45mod error;
46mod files;
47mod html;
48mod init;
49mod page;
50mod page_path;
51mod page_writer;
52mod project;
53mod server;
54mod statics;
55mod version;
56mod watcher;
57
58pub use {
59    cli::*,
60    config::*,
61    error::*,
62    files::*,
63    html::*,
64    init::*,
65    page::*,
66    page_path::*,
67    page_writer::*,
68    project::*,
69    server::*,
70    statics::*,
71    version::*,
72    watcher::*,
73};
74
75#[macro_use]
76extern crate cli_log;