forked from defold/doc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gulpfile.js
283 lines (250 loc) · 8.83 KB
/
gulpfile.js
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
// Node modules
var gulp = require('gulp');
var watch = require('gulp-watch');
var plumber = require('gulp-plumber');
var preservetime = require('gulp-preservetime');
var gutil = require('gulp-util');
var tap = require('gulp-tap');
var jsonlint = require('gulp-jsonlint');
var hljs = require('highlight.js')
var server = require('gulp-server-livereload');
var sass = require('gulp-sass');
var minify = require('gulp-cssnano');
var del = require('del');
var path = require('path');
var mkdirp = require('mkdirp');
var slugify = require('slugify');
var through = require('through2');
var File = require('vinyl');
var hljs = require('highlight.js');
var print = require('gulp-print');
var frontmatter = require('front-matter');
var markdown = require('markdown-it');
var md_attrs = require('markdown-it-attrs');
var md_container = require('markdown-it-container');
var md_deflist = require('markdown-it-deflist')
var md_sub = require('markdown-it-sub');
var md_sup = require('markdown-it-sup');
var md_katex = require('markdown-it-katex');
var hercule = require('hercule');
var exec = require('child_process').exec;
// hljs lua highlight patched
var lua = require('./lib/lua');
hljs.registerLanguage('lua', lua.lua);
md = new markdown({
html: true,
xhtmlOut: true,
breaks: false,
langPrefix: 'language-',
linkify: true,
typographer: true,
highlight: function (str, lang) {
if (lang && hljs.getLanguage(lang)) {
try {
var hl = hljs.highlight(lang, str).value;
// Callouts hack!
return hl.replace(/(?:--|\/\/|#) <([0-9]+)>/g, '<span class="callout" data-pseudo-content="$1"></span>');
} catch (__) {}
}
return ''; // use external default escaping
}});
md.use(md_deflist);
md.use(md_attrs);
md.use(md_sub);
md.use(md_sup);
md.use(md_katex);
md.use(md_container, 'sidenote', { render: rendernote });
md.use(md_container, 'important', { render: rendernote });
// Notes are rendered as two divs so they can be styled right
function rendernote(tokens, idx) {
if (tokens[idx].nesting === 1) {
// opening tag
var type = tokens[idx].info.trim().match(/^(\w+).*$/)[1];
return '<div class="note ' + type + '"><div class="note-icon"></div><div class="note-content">';
} else {
// closing tag
return '</div></div>\n';
}
};
function slugname(str) {
return '_' + slugify(str, '_').toLowerCase();
}
// Add anchors to all headings.
md.renderer.rules.heading_open = function (tokens, idx, options, env, self) {
var tag = tokens[idx].tag;
var title = tokens[idx + 1].content
var slug = slugname(title);
// Add TOC entry
if(!("toc" in env) ) {
env.toc = [];
}
var level = tag.match(/^h(\d+)$/)[1];
env.toc.push({ entry: title, slug: slug, level: level });
return '<div id="' + slug + '" class="anchor"></div>' +
'<' + tag + '>';
};
md.renderer.rules.heading_close = function (tokens, idx, options, env, self) {
var slug = slugname(tokens[idx - 1].content);
var tag = tokens[idx].tag;
if (tag == 'h2' || tag == 'h3')
return '<a href="#' + slug + '"><span class="anchor-link"></span></a>\n'
+ '</' + tag + '>';
else
return '</' + tag + '>';
};
// Images.
md.renderer.rules.image = function (tokens, idx, options, env, self) {
var token = tokens[idx];
if('imgurl' in env) {
// Rewrite src
var src = token.attrs[token.attrIndex('src')][1];
token.attrs[token.attrIndex('src')][1] = env.imgurl + '/' + src;
}
// Set alt attribute
token.attrs[token.attrIndex('alt')][1] = self.renderInlineAsText(token.children, options, env);
return self.renderToken(tokens, idx, options);
};
// Output preview html documents
function markdownToPreviewHtml(file) {
var data = frontmatter(file.contents.toString());
// Inject some styling html for the preview. The built htmls are clean.
var head = '<!DOCTYPE html><html><head><link type="text/css" rel="stylesheet" href="/preview-md.css">' +
'<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.css" integrity="sha384-wITovz90syo1dJWVh32uuETPVEtGigN07tkttEqPv+uR2SE/mbQcG7ATL28aI9H0" crossorigin="anonymous">' +
'</head><body>\n';
head += '<div class="documentation">';
var foot = '</div></body></html>\n';
var html = head + md.render(data.body) + foot;
file.contents = new Buffer(html);
file.path = gutil.replaceExtension(file.path, '.html');
return;
}
var img_url = 'https://storage.googleapis.com/defold-doc';
//var img_url = '/_ah/gcs/defold-doc'; // local dev-server
// Build document json for storage
function markdownToJson(file) {
var name = path.relative(file.base, file.path);
// Needs language for static image url:s
var m = name.match(/^(\w+)[/](\w+)[/].*$/);
var lang = m[1];
var doctype = m[2];
var data = frontmatter(file.contents.toString());
var env = { imgurl: img_url + '/' + lang + '/' + doctype };
data.html = md.render(data.body, env);
data.toc = env.toc;
file.contents = new Buffer(JSON.stringify(data));
file.path = gutil.replaceExtension(file.path, '.json');
return;
}
// Create a map path -> [lang1, lang2 ...] and add it to the
// languages.json file
function langMap(jsonfile) {
var langmap = require('./docs/' + jsonfile);
langmap['filemap'] = {};
return through.obj(function (file, enc, cb) {
var fullpath = path.relative(file.base, file.path);
var m = fullpath.match(/^(\w+)[/](\w+)[/].*$/);
var lang = m[1];
var name = path.relative(lang, fullpath);
if(!langmap['filemap'][name]) {
langmap['filemap'][name] = [];
}
langmap['filemap'][name].push(lang);
cb(null, file);
}, function(cb) {
f = new File({
path: jsonfile,
contents: new Buffer(JSON.stringify(langmap))
});
this.push(f);
cb();
});
}
// Support for transclusion via :[](file.md) syntax
function gulpHercule() {
return through.obj( function(file, encoding, callback) {
if (file.isNull()) {
return callback(null, file);
}
if (file.isBuffer()) {
var options = { 'source': file.path }
hercule.transcludeString(file.contents.toString(encoding), options, function(err, output) {
if (err) {
// Handle exceptions like dead links
process.stderr.write('ERROR: ' + err.message + ' (' + err.path + ')\n');
process.exit(1);
}
file.contents = new Buffer(output);
return callback(null, file);
})
}
if (file.isStream()) {
var transcluder = new hercule.TranscludeStream(options);
transcluder.on('error', (err) => {
// Handle exceptions like dead links
process.stderr.write('ERROR: ' + err.message + ' (' + err.path + ')\n');
process.exit(1);
});
file.contents = file.contents.pipe(transcluder);
return callback(null, file);
}
});
};
// Build docs
gulp.task('build', ['assets'], function () {
gulp.src('docs/**/*.md')
.pipe(gulpHercule())
.pipe(tap(markdownToJson))
.pipe(langMap('languages.json'))
.pipe(gulp.dest("build"))
.pipe(preservetime());;
// jsonfiles directly in lang folders are verified
return gulp.src(['docs/*/*.json'])
.pipe(jsonlint())
.pipe(jsonlint.reporter())
.pipe(gulp.dest("build"))
.pipe(preservetime());;
});
gulp.task('assets', ['clean'], function() {
gulp.src(['docs/assets/**/*.*'])
.pipe(gulp.dest("build/assets"))
.pipe(preservetime());
return gulp.src(['docs/**/*.{png,jpg,svg,gif,js,zip,js}'])
.pipe(gulp.dest("build"))
.pipe(preservetime());
});
// Watch for changes in md files and compile new html
gulp.task('watch', function () {
mkdirp('build/preview');
gulp.src('build/preview')
.pipe(server({
livereload: true,
open: true,
directoryListing: {
enable: true,
path: 'build/preview'
}
}));
watch(['docs/**/*.sass'], function () {
gulp.start('sass');
});
gulp.start('sass');
gulp.src('docs/**/images/**/*.*')
.pipe(watch('docs/**/images/**/*.*'))
.pipe(gulp.dest("build/preview"));
return gulp.src('docs/**/*.md')
.pipe(watch('docs/**/*.md'))
.pipe(gulpHercule())
.pipe(tap(markdownToPreviewHtml))
.pipe(print())
.pipe(gulp.dest("build/preview"));
});
gulp.task('clean', [], function() {
return del(['build']);
});
gulp.task('sass', [], function() {
gulp.src('docs/sass/preview-md.sass')
.pipe(plumber())
.pipe(sass())
.pipe(minify())
.pipe(gulp.dest('build/preview'))
});