Skip to content

Latest commit

 

History

History
21 lines (11 loc) · 777 Bytes

README.md

File metadata and controls

21 lines (11 loc) · 777 Bytes

Doctor allows you to build documentation for your project through XML syntax.

It can be configured through some settings, and different sections of the documentation can be created, which are fully HTML compatible.

To install:

npm install -g doctormake

To generate the single HTML file output, the source file is passed to doctormake (NPM package):

doctormake input.xml output.html

Or manually:

node doctor.js input.xml output.html

This is meant to be a simple one-page documentation generator, yet aiming to aid as much as possible on the work required to create documentation that fits the scope, in a quick painless manner.

This is not a tool to automatically generate documentation from source code.

Demo and Documentation