summaryrefslogtreecommitdiffstats
path: root/lib/config_default.js
blob: 604003dc9bedae4d740f4a7e5f64d9e13c6c5eb5 (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
var path = require('path');

module.exports = {
    // Options that can't be extend
    'configFile': 'book',
    'generator': 'website',
    'extension': null,

    // Book metadats (somes are extracted from the README by default)
    'title': null,
    'description': null,
    'isbn': null,
    'language': 'en',
    'direction': null,
    'author': null,

    // version of gitbook to use
    'gitbook': '*',

    // Structure
    'structure': {
        'langs': 'LANGS.md',
        'readme': 'README.md',
        'glossary': 'GLOSSARY.md',
        'summary': 'SUMMARY.md'
    },

    // CSS Styles
    'styles': {
        'website': 'styles/website.css',
        'print': 'styles/print.css',
        'ebook': 'styles/ebook.css',
        'pdf': 'styles/pdf.css',
        'mobi': 'styles/mobi.css',
        'epub': 'styles/epub.css'
    },

    // Plugins list, can contain '-name' for removing default plugins
    'plugins': [],

    // Global configuration for plugins
    'pluginsConfig': {},

    // Variables for templating
    'variables': {},

    // Set another theme with your own layout
    // It's recommended to use plugins or add more options for default theme, though
    // See https://github.com/GitbookIO/gitbook/issues/209
    'theme': path.resolve(__dirname, '../theme'),

    // Links in template (null: default, false: remove, string: new value)
    'links': {
        // Custom links at top of sidebar
        'sidebar': {
            // 'Custom link name': 'https://customlink.com'
        },

        // Sharing links
        'sharing': {
            'google': null,
            'facebook': null,
            'twitter': null,
            'weibo': null,
            'all': null
        }
    },


    // Options for PDF generation
    'pdf': {
        // Add toc at the end of the file
        'toc': true,

        // Add page numbers to the bottom of every page
        'pageNumbers': false,

        // Font for the file content
        'fontSize': 12,
        'fontFamily': 'Arial',

        // Paper size for the pdf
        // Choices are [u’a0’, u’a1’, u’a2’, u’a3’, u’a4’, u’a5’, u’a6’, u’b0’, u’b1’, u’b2’, u’b3’, u’b4’, u’b5’, u’b6’, u’legal’, u’letter’]
        'paperSize': 'a4',

        // How to mark detected chapters.
        // Choices are “pagebreak”, “rule”, 'both' or “none”.
        'chapterMark' : 'pagebreak',

        // An XPath expression. Page breaks are inserted before the specified elements.
        // To disable use the expression: '/'
        'pageBreaksBefore': '/',

        // Margin (in pts)
        // Note: 72 pts equals 1 inch
        'margin': {
            'right': 62,
            'left': 62,
            'top': 56,
            'bottom': 56
        },

        // Header HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
        'headerTemplate': null,

        // Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
        'footerTemplate': null
    }
};