summaryrefslogtreecommitdiffstats
path: root/lib/generate/site/index.js
blob: 9d738be77d01e2854ae9030b8e60bf734a78d377 (plain)
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
var util = require("util");
var path = require("path");
var Q = require("q");
var _ = require("lodash");
var swig = require('swig');

var fs = require("../fs");
var parse = require("../../parse");
var BaseGenerator = require("../generator");

var indexer = require('./search_indexer');

// Swig filter for returning the count of lines in a code section
swig.setFilter('lines', function(content) {
    return content.split('\n').length;
});

// Swig filter for returning a link to the associated html file of a markdown file
swig.setFilter('mdLink', function(link) {
    var link = link.replace(".md", ".html");
    if (link == "README.html") link = "index.html";
    return link;
});

var Generator = function() {
    BaseGenerator.apply(this, arguments);

    // Attach methods to instance
    _.bindAll(this);

    this.revision = Date.now();
    this.indexer = indexer();

    // Load base template
    this.template = swig.compileFile(path.resolve(this.options.theme, 'templates/site.html'));
    this.langsTemplate = swig.compileFile(path.resolve(this.options.theme, 'templates/langs.html'));
};
util.inherits(Generator, BaseGenerator);


// Generate a template
Generator.prototype._writeTemplate = function(tpl, options, output) {
    var that = this;
    return Q()
    .then(function(sections) {
        return tpl(_.extend({
            revision: that.revision,

            title: that.options.title,
            description: that.options.description,

            githubAuthor: that.options.github ? that.options.github.split("/")[0] : "",
            githubId: that.options.github,
            githubHost: that.options.githubHost,

            summary: that.options.summary,
            allNavigation: that.options.navigation,

            plugins: that.plugins
        }, options));
    })
    .then(function(html) {
        return fs.writeFile(
            output,
            html
        );
    });
};

Generator.prototype.indexPage = function(lexed, pagePath) {
    this.indexer.add(lexed, pagePath);
    return Q();
};

// Convert a markdown file to html
Generator.prototype.convertFile = function(content, _input) {
    var that = this;
    var progress = parse.progress(this.options.navigation, _input);

    _output = _input.replace(".md", ".html");
    if (_output == "README.html") _output = "index.html";

    var input = path.join(this.options.input, _input);
    var output = path.join(this.options.output, _output);
    var basePath = path.relative(path.dirname(output), this.options.output) || ".";

    return Q()
    .then(function() {
        // Lex page
        return parse.lex(content);
    })
    .then(function(lexed) {
        // Index page in search
        return that.indexPage(lexed, _output)
        .then(_.constant(lexed));
    })
    .then(function(lexed) {
        // Get HTML generated sections
        return parse.page(lexed, {
            repo: that.options.githubId,
            dir: path.dirname(_input) || '/',
            outdir: path.dirname(_input) || '/',
        });
    })
    .then(function(sections) {
        return that._writeTemplate(that.template, {
            progress: progress,

            _input: _input,
            content: sections,

            basePath: basePath,
            staticBase: path.join(basePath, "gitbook"),
        }, output);
    });
};

// Generate languages index
Generator.prototype.langsIndex = function(langs) {
    var that = this;
    var basePath = ".";

    return this._writeTemplate(this.langsTemplate, {
        langs: langs.list,

        basePath: basePath,
        staticBase: path.join(basePath, "gitbook"),
    }, path.join(this.options.output, "index.html"))
    .then(function() {
        // Copy assets
        return that.copyAssets();
    });
};

// Copy assets
Generator.prototype.copyAssets = function() {
    var that = this;

    // Copy gitbook assets
    return fs.copy(
        path.join(that.options.theme, "assets"),
        path.join(that.options.output, "gitbook")
    )
    // Copy plugins assets
    .then(function() {
        return Q.all(
            _.map(that.plugins.resources, function(resources, resourceType) {
                return Q.all(_.map(resources, function(resource) {
                    return fs.copy(
                        resource.path,
                        path.join(that.options.output, "gitbook/plugins/", resource.id+"."+resourceType)
                    );
                }));
            })
        );
    })
};

// Dump search index to disk
Generator.prototype.writeSearchIndex = function() {
    return fs.writeFile(
        path.join(this.options.output, 'search_index.json'),
        this.indexer.dump()
    );
};

Generator.prototype.finish = function() {
    return this.copyAssets()
    .then(this.writeSearchIndex);
};

module.exports = Generator;