v0.5.0

doxydoc.json file

Doxydoc is configurable with a doxydoc.json file placed in the projects root directory.

Example

{ "name": "DoxyDoc", "version": "1.0.3", "header": [ { "link": "docu.html", "name": "Docu" }, { "link": "http://doxydoc.com/syntax/syntax.html", "name": "Syntax", "target": "_blank" } ], "navigation": [ { "link": "example-md.html", "file": "test/pages/example.md", "name": "Markdown file" }, { "link": "example-fire.html", "file": "test/pages/example.fire", "name": "FireTPL file" }, { "link": "example-html.html", "file": "test/pages/example.html", "name": "HTML file" } ], "indexPage": "README.md", "styles": "my/custom.css", "scripts": "my/custom.js" }

Properties

name

Define a project name. The name is shown as page title.

version

Sets a version. The version is shown right of the name in the page title.

indexPage

Defines the link under the logo.

{ "indexPage": "/" }

livereload

Enables live reload support. Enter either a port number or a boolean
This flag should not be used on production!

{ "livereload": 13987 }

logoImage

Defines a logo image

{ "logoImage": "img/logo.png" }

docs

Configures the documentation generator
Parses all files from files and generates a documentation under output

{ "docs": [ { "files": "../doxydoc/src/*.js", "output": ["docs.json", "docs.html"] } ] }

Defines a navigation struckture. A navigation is an array of links.
See Link item for more details

{ "navigation": [ { "file": "README.md", "link": "index.html", "name": "Index" }, { "link": "docs.html", "name": "Docs" } ] }

outputDir

Defines an output directory. All created files will be stored under this directory.

{ "outputDir": "public/" }

Defines a sidebar link struckture. A sidebar is an array of links.
See Link item for more details

{ "sidebar": [ { "file": "README.md", "link": "index.html", "name": "Index" }, { "link": "docs.html", "name": "Docs" } ] }

page

Takes same arguments like sidebar or navigation. Create pages but does not create any navigation items.

{ "pages": [ { "file": "README.md", "link": "index.html" } ] }

basePath

Sets a base path. Will be added in relative script and style paths.

Link items can be used in sidebar and navigation properties.
A link item represents one link in a navigation or sidebar. The list below describes all link item properties.

name (required)

Defines a link name. This property is required.

The link target. If file is used, this property defines also the filename

file

Parse file and create a new page. Uses link as filename for the new page

target

Link target. Default _self

title

Defines a page title. Only supported if file is used.

cssClass

Css class for the link.

Parse page for h1 - h6 and creates a sub-navigation. Uses the h* tags as anchors. Only supported in a sidebar and if file option is used.

Creates a sub-navigation. Takes an array of Link items.
Only supported in a sidebar

{ "sidebar": [ { "link": "#", "name": "Parent", "subNavigation": [ { "link": "child1.html", "name": "Child 1" }, { "link": "child2.html", "name": "Child 2" }, { "link": "#", "name": "Child 3", "subNavigation": [ { "link": "subchild1.html", "name": "Sub Child 1" } ] } ] } ] }

scripts

Add script to current page.

styles

Add style to current page.