Gitbook draft

Last modified 2 years ago / Edit on Github
Warning
This post was updated more than 1 year ago, some information may be outdated!
Warning
This is a draft, the content is not complete and of poor quality!

URLs

Setting up

File book.json needs to be placed in the root of your gitbook repository on Github. Below are some settings that I have used.

{
"plugins": [
"mathjax"
],
"pluginsConfig": {
"mathjax":{
"forceSVG": true
}
}
}

Math in Gitbook

You have to use $$a+b$$ instead of $a+b$ for inline math. Others are the same as normal expressions in Markdown.

Blocks

Boxes

Info blocks,

{% hint style="info" %}
Hint blocks.
<br />Line break.
{% endhint %}

Danger blocks,

{% hint style="danger" %}
Content.
{% endhint %}

Success blocks,

{% hint style="success" %}
Content.
{% endhint %}

Warning blocks,

{% hint style="warning" %}
Content.
{% endhint %}

Code blocks

{% code-tabs %}
{% code-tabs-item title="book.json" %}
```bash
cd directory/
```
{% endcode-tabs-item %}
{% endcode-tabs %}

Box with tabs

{% tabs %}
{% tab title="First Tab" %}
Content of tab 1.
{% endtab %}

{% tab title="Second Tab" %}
Content of tab 2.
{% endtab %}
{% endtabs %}

Tasks

* [x] Task 1
* [ ] Task 2
* [ ] Task 3