-
Notifications
You must be signed in to change notification settings - Fork 2
/
jsdoc.json
27 lines (27 loc) · 1.17 KB
/
jsdoc.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
// Execute meteor-jsdoc in debug mode to track down errors.
"debug": false,
// node.js install path, default to: "`which node`" on Mac and Linux, "`where node`" on Windows
"nodePath": "",
// Project docs path
"docsPath": "~/pair-research-meteor-docs",
// Project docs Meteor server port, default to: 3333
"meteorPort": 3333,
// Copy the Meteor docs server before building the docs (required for the first build)
// Setting this to false after the first build allows you to customize the docs templates
// without seeing your changes overwritten the next time you build the docs.
"initMeteor": true,
// Update Meteor without overwriting your changes to the docs templates.
"updateMeteor": true,
// Add a preamble to your project's docs that will appear at the top of the docs.
"preamble": true,
// Link to the project repository (used to construct the file path in the docs). Optional.
"projectRepo": "https://github.com/NUDelta/pair-research-meteor",
// Values to be used in the `<head>` for the docs.
"docsConfig": {
"title": "Pair Research API Docs",
"metas": {
"description": "Pair Research Meteor platform documentation."
}
}
}