Skip to content
This repository has been archived by the owner on Oct 5, 2019. It is now read-only.
/ MaterialDoc Public archive

very simple documentation generator. Obsolete now, I recommend using adrdox for more features instead and style it.

Notifications You must be signed in to change notification settings

WebFreak001/MaterialDoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MaterialDoc

Tutorial

To use it simply generate the ddoc documentation using dmd and generate an index.json using the -XfdocFolder/index.json switch for dmd. Then just put that folder where the exe is and run the exe with --df=docFolder/ as argument

Then the output html files will generate to out/

Dub usage

For generating an index.json in dub just add "dflags": ["-XfdocFolder/index.json"] to the dub.json.

Then do the above.

Console Arguments

Argument Description
df Input directory where ddoc files are.
of Output directory of the documentation
index index.json file from -Xf switch (Relative to .exe or to docFolder/)
replaceColors Automatically replace with
css Specifies the stylesheet.css location (Relative to .exe)
forceRemove Removes the output directory before generating

Screenshots

Example Screenshot

About

very simple documentation generator. Obsolete now, I recommend using adrdox for more features instead and style it.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published