ddoc 0.16.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

[![MIT][s2]][l2] [![Latest Version][s1]][l1] [![docs][s3]][l3] [![Chat on Miaou][s4]][l4]

[s1]: https://img.shields.io/crates/v/ddoc.svg
[l1]: https://crates.io/crates/ddoc

[s2]: https://img.shields.io/badge/license-MIT-blue.svg
[l2]: LICENSE

[s3]: https://docs.rs/ddoc/badge.svg
[l3]: https://docs.rs/ddoc/

[s4]: https://miaou.dystroy.org/static/shields/room.svg
[l4]: https://miaou.dystroy.org/3


# ddoc

<!-- cradoc start -->

**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

`/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.

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
```

<!-- cradoc end -->