summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-markdown/src/page.js
blob: b899d5bcf423b025df649ef35292896638d502a4 (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
const { State, Block, Text, Inline, INLINES, BLOCKS, MARKS } = require('markup-it');
const markdown = require('markup-it/lib/markdown');

const RAW_START = 'raw';
const RAW_END   = 'endraw';

/**
 * Create a templating node.
 * @param {String} expr
 * @return {Node}
 */
function createTemplatingNode(expr) {
    return Inline.create({
        type: INLINES.TEMPLATE,
        data: {
            type: 'expr',
            text: expr
        }
    });
}

/**
 * Escape a code block.
 * @param  {Block} block
 * @return {Array<Node>} blocks
 */
function escapeCodeBlock(block) {
    return [
        Block.create({
            type: BLOCKS.TEXT,
            nodes: [
                createTemplatingNode(RAW_START)
            ]
        }),
        block,
        Block.create({
            type: BLOCKS.TEXT,
            nodes: [
                createTemplatingNode(RAW_END)
            ]
        })
    ];
}


/**
 * Escape a text node.
 * @param  {Text} node
 * @return {Array<Node>} nodes
 */
function escapeTextNode(node) {
    const ranges = node.getRanges();

    const nodes = ranges.reduce((result, range) => {
        const hasCode = range.marks.some(mark => mark.type == MARKS.CODE);
        const text = Text.createFromRanges([ range ]);

        if (hasCode) {
            return result.concat([
                createTemplatingNode(RAW_START),
                text,
                createTemplatingNode(RAW_END)
            ]);
        }

        return result.concat([ text ]);
    }, []);

    return nodes;
}

/**
 * Annotate a block container.
 * @param  {Node} parent
 * @param  {Number} levelRaw
 * @return {Node} node
 * @return {Number} levelRaw
 */
function annotateNode(parent, levelRaw) {
    let { nodes } = parent;

    nodes = nodes.reduce((out, node) => {
        if (node.type === INLINES.TEMPLATE) {
            const { type, text } = node.data.toJS();

            if (type === 'expr') {
                if (text === 'raw') {
                    levelRaw = levelRaw + 1;
                } else if (text == 'endraw') {
                    levelRaw = 0;
                }
            }

            return out.concat([ node ]);
        }

        else if (node.type === BLOCKS.CODE) {
            return out.concat(
                levelRaw == 0 ? escapeCodeBlock(node) : [ node ]
            );
        }

        else if (node.kind == 'text') {
            return out.concat(
                levelRaw == 0 ? escapeTextNode(node) : [ node ]
            );
        }

        const result = annotateNode(node, levelRaw);
        levelRaw = result.levelRaw;
        return out.concat([result.node]);
    }, []);

    return {
        levelRaw,
        node: parent.merge({ nodes })
    };
}

/**
 * Add templating "raw" to code blocks to
 * avoid nunjucks processing their content.
 *
 * @param {String} src
 * @return {String}
 */
function preparePage(src) {
    const state = State.create(markdown);
    let document = state.deserializeToDocument(src);
    document = annotateNode(document, 0).node;

    return state.serializeDocument(document);
}

module.exports = {
    prepare: preparePage
};