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!
- Easily configurable for any project, designed to work as a git-submodule.
- Sidebar with a package explorer tree and a tree of the symbols in the current module.
- Configurable titlebar, with a go-to-symbol form.
- Fully qualified page anchor names; individual symbols can be linked without conflicting with similarly named symbols in the same module.
- Neat styling using Bootstrap.
Usage with Github Pages
- Create a gh-pages branch to host the generated documentation (instructions here).
- For the purposes of this guide, we will assume this is an empty branch in its own repository in a subdirectory of the repository containing the source files. Since we're using a clean slate branch which still depends on the contents of the master branch (or whatever branch you want to generate documentation for), two separate repositories are required.
- For example, if your project repository is in a directory
myproj, we will assume your gh-pages repository is in
- The working directory of the following commands is assumed to be this new directory (e.g.
- Add bootDoc as a git-submodule to your gh-pages repository:
git submodule add git://github.com/JakobOvrum/bootDoc.git bootDoc
bootDocto the current directory:
cp bootDoc/settings.ddoc settings.ddoc; cp bootDoc/modules.ddoc modules.ddoc;
modules.ddocto match your project's profile (see below).
- Run the generation tool, passing the root location of your sources:
rdmd bootDoc/generate.d ...
- The list of modules is read from
modules.ddoc. For example, using the above command, if your
modules.ddochas one entry
$(MODULE example.example), then
example.example.htmlwill be generated from
- If you have an index file tracked on the gh-pages branch instead of among the sources, pass it to the generation tool using
--extra=index.d. Any number of extra files can be passed this way.
- Push your newly generated HTML files.
- To update the documentation, run the generation tool again.
Usage in General
DDoc is configured using the files
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
a candyDoc-style list of all the modules in your project, and is documented
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).