@honkit-plugin-fontsettings

@honkit/honkit-plugin-fontsettings is a fork of [Gitbook/plugin-fontsettings]@2.0.0.

This plugin adds font settings button in the HonKit website.

$3

This is a default plugin and it can be disabled using a book.json configuration:

``
{
plugins: ["-fontsettings"]
}
`

$3

This plugin can be configured in the book.json:

Default configuration is:

`js
{
"pluginsConfig": {
"fontsettings": {
"theme": 'white', // 'sepia', 'night' or 'white',
"family": 'sans', // 'serif' or 'sans',
"size": 2 // 1 - 4
}
}
}
`

$3

This plugin exposes the following API to easily allow new themes to manage the plugin behavior.

All API functions are called using the prefix gitbook.fontsettings., for instance gitbook.fontsettings.enlargeFontSize().

#### Font manipulation

##### gitbook.fontsettings.enlargeFontSize()

Increases the font size of the document by one. Max value is 4.

##### gitbook.fontsettings.reduceFontSize()

Decreases the font size of the document by one. Min value is 1.

#### Font families

Each font family should be described as:

`js
var fontFamily = {
config: 'sans', // name of the font family in book.json for your theme
text: 'Sans', // display name of the font family in menu
id: 0 // the id appended to the CSS class for this font-family
};
`

The text property will be used to display the font-family name in the fontsettings dropdown menu.

The config property allows you to let the users of your theme choose a default font family in their book.json. You will have to handle setting the chosen font family in your theme's frontend JavaScript.

For instance:

`json
// book.json
{
plugins: ["my-theme"],
pluginsConfig: {
"my-theme": {
"font-family": "sans"
}
}
}
`

`js
// my-theme.js
require('gitbook', function(gitbook) {
var FONT_FAMILIES = [
{
config: 'sans',
text: 'Sans',
id: 0
},
{
config: 'serif',
text: 'Serif',
id: 1
}
];

gitbook.events.on('start', function(e, config) {
// Read configuration
var themeConfig = config['my-theme'],
defaultFont = themeConfig['font-family'];

// Initialize new font families
gitbook.fontsettings.setFamilies(FONT_FAMILIES);
// Set to configured font-family
gitbook.fontsettings.setFamily(defaultFont);
});
});
`

The id property lets you define a specific id to use for your CSS rules as explained below.

##### CSS rules

The CSS class font-family- will be applied to the theme book's root element