DDoc theme using Bootstrap for styling. bootDoc uses JavaScript to extend and improve DDoc's capabilities, such as by adding a module overview tree and by enabling fully qualified page anchors.
The theme is designed to work with any project by putting all project-specific information in separate configuration files.
Please post bugs, enhancement requests and questions on the Github issue tracker. Thanks!
Phobos documentation using bootDoc can be found here. Additionally, the LuaD documentation uses bootDoc.
myproj
, we will assume your gh-pages repository is in myproj/gh-pages
.myproj/gh-pages
).git submodule add git://github.com/JakobOvrum/bootDoc.git bootDoc
settings.ddoc
and modules.ddoc
from bootDoc
to the current directory:
cp bootDoc/settings.ddoc settings.ddoc;
cp bootDoc/modules.ddoc modules.ddoc;
settings.ddoc
and modules.ddoc
to match your project's profile (see below).rdmd bootDoc/generate.d ..
.
modules.ddoc
. For example, using the above command, if your modules.ddoc
has one entry $(MODULE example.example)
, then example.example.html
will be generated from ../example/example.d
(aka myproj/example/example.d
).--extra=index.d
. Any number of extra files can be passed this way.DDoc is configured using the files bootdoc.ddoc
, settings.ddoc
and modules.ddoc
.
The latter two are templates; copy them to your project directory before editing them.
settings.ddoc
contains general information about your project; its values are
documented here. modules.ddoc
contains
a candyDoc-style list of all the modules in your project, and is documented
here.
Pages are generated using the included tool generate.d
. Run it without arguments to
see an overview of how to use it.
bootDoc is licensed under the terms of the MIT license (see the LICENSE file for details).
Thanks to Robik for his work on cuteDoc, which inspired this project.