FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
ionic/scripts/docs/dgeni-config.js at angular-rc1 · Java1024/ionic · GitHub
Java1024
ionic
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
ionic
/
scripts
/
docs
/
dgeni-config.js
Copy path
More file actions
More file actions
Latest commit
History
History
History
179 lines (153 loc) · 5.49 KB
Breadcrumbs
ionic
/
scripts
/
docs
/
dgeni-config.js
Copy path
File metadata and controls
179 lines (153 loc) · 5.49 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
var
Package
=
require
(
'dgeni'
)
.
Package
;
var
jsdocPackage
=
require
(
'dgeni-packages/jsdoc'
)
;
var
nunjucksPackage
=
require
(
'dgeni-packages/nunjucks'
)
;
var
typescriptPackage
=
require
(
'./typescript-package'
)
;
var
linksPackage
=
require
(
'./links-package'
)
;
var
gitPackage
=
require
(
'dgeni-packages/git'
)
;
var
path
=
require
(
'path'
)
;
var
semver
=
require
(
'semver'
)
;
var
fs
=
require
(
'fs'
)
;
var
_
=
require
(
'lodash'
)
;
var
config
=
require
(
'../config.json'
)
;
// Define the dgeni package for generating the docs
module
.
exports
=
function
(
currentVersion
)
{
return
new
Package
(
'ionic-v2-docs'
,
[
jsdocPackage
,
nunjucksPackage
,
typescriptPackage
,
linksPackage
,
gitPackage
]
)
.
processor
(
require
(
'./processors/latest-version'
)
)
.
processor
(
require
(
'./processors/index-page'
)
)
.
processor
(
require
(
'./processors/jekyll'
)
)
.
processor
(
require
(
'./processors/remove-private-members'
)
)
.
processor
(
require
(
'./processors/hide-private-api'
)
)
.
processor
(
require
(
'./processors/collect-inputs-outputs'
)
)
.
processor
(
require
(
'./processors/parse-returns-object'
)
)
// for debugging docs
// .processor(function test(){
// return {
//
// $runBefore: ['rendering-docs'],
// $process: function(docs){
// docs.forEach(function(doc){
// if (doc.name == "Searchbar"){
// console.log(doc.input);
// doc.members.forEach(function(method){
// if (method.name === "load") {
// console.log(method);
// }
// })
// }
// })
// }
// }
// })
.
config
(
function
(
log
)
{
log
.
level
=
'error'
;
//'silly', 'debug', 'info', 'warn', 'error'
}
)
.
config
(
function
(
renderDocsProcessor
,
computePathsProcessor
,
versionInfo
)
{
try
{
versions
=
fs
.
readdirSync
(
path
.
resolve
(
__dirname
,
'../../'
+
config
.
docsDest
+
'/'
)
)
.
filter
(
semver
.
valid
)
}
catch
(
e
)
{
versions
=
[
]
;
}
// new version, add it to the versions list
if
(
currentVersion
!=
'nightly'
&&
!
_
.
contains
(
versions
,
currentVersion
)
)
{
versions
.
unshift
(
currentVersion
)
;
}
// sort by version so we can find latest
versions
.
sort
(
semver
.
rcompare
)
;
// add nightly if it isn't in the list
!
_
.
contains
(
versions
,
'nightly'
)
&&
versions
.
unshift
(
'nightly'
)
;
//First semver valid version is latest
var
latestVersion
=
_
.
find
(
versions
,
semver
.
valid
)
;
versions
=
versions
.
map
(
function
(
version
)
{
//Latest version is in docs root
//var folder = version == latestVersion ? '' : version;
// Instead set nightly as docs root
var
folder
=
version
==
'nightly'
?
''
:
version
;
return
{
href
:
path
.
join
(
'/'
+
config
.
v2DocsDir
,
folder
)
,
folder
:
folder
,
name
:
version
}
;
}
)
;
var
versionData
=
{
list
:
versions
,
current
:
_
.
find
(
versions
,
{
name
:
currentVersion
}
)
,
latest
:
_
.
find
(
versions
,
{
name
:
latestVersion
}
)
||
_
.
first
(
versions
)
}
;
renderDocsProcessor
.
extraData
.
version
=
versionData
;
renderDocsProcessor
.
extraData
.
versionInfo
=
versionInfo
;
computePathsProcessor
.
pathTemplates
=
[
{
docTypes
:
[
'class'
,
'var'
,
'function'
,
'let'
]
,
getOutputPath
:
function
(
doc
)
{
// strip ionic from path root
var
docPath
=
doc
.
fileInfo
.
relativePath
.
replace
(
/
^
i
o
n
i
c
\/
/
,
''
)
;
// remove filename since we have multiple docTypes per file
docPath
=
docPath
.
substring
(
0
,
docPath
.
lastIndexOf
(
'/'
)
+
1
)
;
docPath
+=
doc
.
name
+
'/index.md'
;
var
path
=
config
.
v2DocsDir
+
'/'
+
(
versionData
.
current
.
folder
||
''
)
+
'/api/'
+
docPath
;
path
=
path
.
replace
(
'/home/ubuntu/ionic/ionic'
,
''
)
return
path
;
}
}
]
;
}
)
//configure file reading
.
config
(
function
(
readFilesProcessor
,
readTypeScriptModules
)
{
// Don't run unwanted processors since we are not using the normal file reading processor
readFilesProcessor
.
$enabled
=
false
;
readFilesProcessor
.
basePath
=
path
.
resolve
(
__dirname
,
'../..'
)
;
readTypeScriptModules
.
basePath
=
path
.
resolve
(
path
.
resolve
(
__dirname
,
'../..'
)
)
;
readTypeScriptModules
.
sourceFiles
=
[
'ionic/index.ts'
]
;
}
)
.
config
(
function
(
parseTagsProcessor
)
{
parseTagsProcessor
.
tagDefinitions
=
parseTagsProcessor
.
tagDefinitions
.
concat
(
require
(
'./tag-defs/tag-defs'
)
)
;
}
)
// .config(function(parseTagsProcessor) {
// // We actually don't want to parse param docs in this package as we are getting the data out using TS
// parseTagsProcessor.tagDefinitions.forEach(function(tagDef) {
// console.log(tagDef);
// if (tagDef.name === 'param') {
// tagDef.docProperty = 'paramData';
// tagDef.transforms = [];
// }
// });
// })
// Configure links
.
config
(
function
(
getLinkInfo
)
{
getLinkInfo
.
useFirstAmbiguousLink
=
false
;
}
)
// Configure file writing
.
config
(
function
(
writeFilesProcessor
)
{
writeFilesProcessor
.
outputFolder
=
config
.
sitePath
;
}
)
// Configure rendering
.
config
(
function
(
templateFinder
,
templateEngine
)
{
// Nunjucks and Angular conflict in their template bindings so change the Nunjucks
// Also conflict with Jekyll
templateEngine
.
config
.
tags
=
{
variableStart
:
'<$'
,
variableEnd
:
'$>'
,
blockStart
:
'<@'
,
blockEnd
:
'@>'
,
commentStart
:
'<#'
,
commentEnd
:
'#>'
}
;
// add custom filters to nunjucks
templateEngine
.
filters
.
push
(
require
(
'./filters/capital'
)
,
require
(
'./filters/code'
)
,
require
(
'./filters/dump'
)
)
;
templateFinder
.
templateFolders
.
unshift
(
path
.
resolve
(
__dirname
,
'templates'
)
)
;
// Specify how to match docs to templates.
templateFinder
.
templatePatterns
=
[
'${ doc.template }'
,
'${ doc.docType }.template.html'
,
'common.template.html'
]
}
)
}
Back
|
FazBrowse Home
|
New Git URL