ddoc 0.18.0

doc site generator
Documentation

MIT Latest Version docs Chat on Miaou

ddoc

ddoc is a markdown based static site generator.

Complete documentation at https://dystroy.org/ddoc

Usage overview

Create a directory, then move to it

mkdir website & cd website

Initialize the site:

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

ddoc

This updates a site directory, whose content can be sent to your server.

To test it locally, run

ddoc --serve

Then have a look at the documentation to improve your site.