配置JSDoc的默认模板

原文：http://usejsdoc.org/about-configuring-default-template.html

JSDoc的默认模板中提供了几个选项，您可以使用自定义外观和生成的文档内容。

要使用这些选项，您必须为JSDoc创建一个配置文件，并在配置文件中设置相应的选项。

生成漂亮的打印源文件

默认情况下，JSDoc的默认模板生成你的源文件适合打印的版本。在文档中，它还链接到这些适合的打印文件。

要禁用适合打印的文件，设置选项templates.default.outputSourceFiles为false。使用该选项也将删除文档中链接到源文件的连接。此选项在JSDoc3.3.0及更高版本上是可用的。

复制静态文件的输出目录

JSDoc的默认模板中自动复制几个静态文件，如CSS样式表，到输出目录。在JSDoc3.3.0或更高版本，你可以告诉默认模板复制其他静态文件到输出目录。例如，您可能希望复制一个图像的目录到输出目录，所以你可以在你的文档中显示这些图像。

要附加静态文件复制到输出目录，使用下列选项：

templates.default.staticFiles.include：路径的数组，其内容应复制到输出目录。子目录也将被复制。

templates.default.staticFiles.exclude：路径的数组，那不应该被复制到输出目录。

templates.default.staticFiles.includePattern：正则表达式，说明其要复制的文件。如果这个属性没有被定义，所有的文件将被复制。

templates.default.staticFiles.excludePattern：正则表达式，说明哪些文件跳过。如果这个属性没有被定义，什么都不会被跳过。

复制图像的目录到输出目录

要复制所有的静态文件在./myproject/static到输出目录中：

{
"templates": {
"default": {
"staticFiles": {
"include": [
"./myproject/static"
]
}
}
}
}

如果您的静态文件目录中包含的文件./myproject/static/img/screen.png，您可以显示图像在您的文档

<img src="img/screen.png">

。

显示当前日期在页脚

默认情况下，JSDoc的默认模板总是显示当前日期生成的文档页脚。在JSDoc3.3.0或更高版本，可以忽略当前的日期,通过设置选项templates.default.includeDate为false。

覆盖默认模板的布局文件

默认的模板使用名为layout.tmpl指定页眉和页脚为每个页面文件在生成的文档中。特别是，该文件定义了CSS和JavaScript文件的加载为每一页。在JSDoc3.3.0或更高版本，可以指定自己的layout.tmpl文件来使用，它允许你加载自己的自定义CSS和JavaScript文件，除了或替代，标准的文件。

要使用此功能，设置选项templates.default.layoutFile的路径到你的自定义布局文件。相对路径解决了针对路径文件config.json;当前的工作目录;和JSDoc目录，在该顺序。