Skip to content

Welcome page

nene edited this page Aug 8, 2012 · 1 revision

The --welcome option allows defining a welcome page for the docs. Just use:

--welcome=path/to/your-page.html

The file should contain only the <body> part of an HTML file. You might also want to include your own stylesheet, which you can place to the <head> section using something like that:

--head-html='<link rel="stylesheet" href="style.css" type="text/css">'

Note that you need to copy the stylesheet file manually to JSDuck output directory, so for just a few styles using <style> tags could be much simpler.

Something went wrong with that request. Please try again.