-
Notifications
You must be signed in to change notification settings - Fork 0
/
jsdoc.json
55 lines (55 loc) · 1.91 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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
"source": {
"includePattern": ".+\\.js(doc|x)?$", // Only process file ending in .js, .jsdoc or .jsx
"include": [
".",
"README.md"
], // Check all folders.
"exclude": [
"node_modules"
] // Be gone, node_modules.
},
"recurseDepth": 10, // Only go 10 levels deep.
"opts": {
"template": "node_modules/docdash",
"destination": "./docs/", // Where I want my docs to be generated.
"recurse": true // Same as using -r or --recurse
},
"docdash": {
"static": [
true
], // Display the static members inside the navbar
"sort": [
true
], // Sort the methods in the navbar
"sectionOrder": [
// Order the main section in the navbar (default order shown here)
"Classes",
"Modules",
"Externals",
"Events",
"Namespaces",
"Mixins",
"Tutorials",
"Interfaces"
],
"disqus": "", // Shortname for your disqus (subdomain during site creation)
"openGraph": {
// Open Graph options (mostly for Facebook and other sites to easily extract meta information)
"title": "Linked Data Signatures for GPG", // Title of the website
"type": "documentation", // Type of the website
"image": "http://gpg.jsld.org/image.jpg", // Main image/logo
"site_name": "JSON-LD Signature Suite for GPG", // Site name
"url": "http://gpg.jsld.org" // Main canonical URL for the main page of the site
},
"meta": {
// Meta information options (mostly for search engines that have not indexed your site yet)
"title": "JSON-LD Signature Suite for GPG", // Also will be used as postfix to actualy page title, prefixed with object/document name
"description": "Linked Data Signatures for GPG Developers.", // Description of overal contents of your website
"keyword": "jsonld,gpg,linked-data,rdf,graph,signature" // Keywords for search engines
},
"search": [
true
]
}
}