settings.ddoc contains general information about your project. It is a template file; copy it out of the bootDoc repository before editing it.

As with all .ddoc files, remember to put a newline at the end of the file.

• PROJECTNAME

• The name of your project. It is used in the page title and titlebar.

• REFERENCETOP

• Path to the index page of your documentation. This is the URL target of the "Reference" link in the titlebar.

• REPOSRCTREE

• Path to the root of the source tree associated with this project. Used for the "view source" link next to the module name. The link is $(REPOSRCTREE)/<module path>, where the module path is created by taking the fully qualified module name, replacing dots with slashes, then appending the .d extension. For example, in a module example.example, "view source" will link to $(REPOSRCTREE)/example/example.d.
• For example, for Github-hosted projects, use https://github.com/Username/Repository/tree/master or https://github.com/Username/Repository/tree/master/src etc.
• This can be overridden by individual modules by providing a Macros: section in your module documentation (see "Special Sections"). This can be useful for index pages and the likes.

• TITLEBARTEXT

• Right-aligned text in the titlebar. Can be used for anything, such as linking to a Github repository (<a href="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/Username/Repository">Github Page</a>).

• RESOURCEROOT

• Prefix for all bootDoc resource URLs (with a trailing slash!). For example, if all bootDoc resources are in the same directory as the HTML files, leave it blank. If the resources are in a subdirectory of the directory holding the HTML files, set it to the name of that subdirectory (e.g. bootDoc/). Prepend a / to use absolute paths.

• ISSUETRACKER

• Link to project bug/issue tracker, taking the ticket as its first argument. Used by the BUGREF and ISSUEREF macros (see Macros).

• DEFAULTPACKAGE

• Main source package of the project. Configures the DPREF and DPMODULE macros (see Macros).

• PACKAGESEP

• Package separator for links to other modules. This should match the --separator option passed to the generator tool. Set to . to make links in the noscript module list work. Set to / if modules are nested in directories (such as when generated with DMD's -op).

• FAVICON

• URL of the favicon. For example, if your favicon is a file favicon.png in the same directory as the HTML files, set it to favicon.png.

• LOGOSRC

• URL of the logo, appearing to the far right of the module name. For example, if your logo is a file logo.png in the same directory as the HTML files, set it to logo.png.

• LOGOALT

• The alt attribute of the logo. Typically set to $(PROJECTNAME).

• LOGOLINK

• The href attribute of the logo. Typically set to $(REFERENCETOP).

• COPYRIGHT

• Displayed at the bottom of each page. Typically overridden by using the Copyright: special section in the source file (see "Special Sections").

• COPYRIGHTFOOTER

• The full copyright footer. e.g. &copy; $(COPYRIGHT) <start year>-$(YEAR), where <start year> is the year in which the copyright was acquired.