Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.04 KB

usage.md

File metadata and controls

31 lines (19 loc) · 1.04 KB

Simple Markdown Generator


1 Usage

The tool can be downloaded from GitHub.

The usage of the tool is quite simple, it has just two arguments

mdgen <source folder> <target folder>`

Additionally there are two options:

  • --doc prints the document graph
  • --copy copies used resources (images) from theit source into the generated document tree.

This documentation is generated from the src folder of the project mandelsoft/mdgen.

The generator evaluates all .mdg files in the source folder hierarchy and generates appropriate markdown files with the same folder structure in the target folder.

To start, please have a look at the concept section. More details about the available generator statements used to control the generation process can be found in the statements section.