DATABOOK-THEME

Databook is a highly customizable Jekyll theme, which is designed for building personal sites, blogs, and documentations.

Features

Common

• Responsive layouts
• Light/dark mode with tunable accent color
• Multiple language user interface
• JavaScript library
• Fully compatible with GitHub Pages

Components

• Different style sidebars
• Single-page application style documentations
• Pinned Posts
• Search (built-in or google)
• Mathematics (Mathjax or KaTeX)
• Diagrams (Chart.js, Flowchart.js, Mermaid)
• Comments (Disqus, Gitalk)
• Analytics (Google Analytics)

Getting started

Using GitHub template (recommended)

Using databook-boilerplate, you can easily build and manage a site through browser without any programming knowledge.

1. Click here to create a new repository and name it <username>.github.io, where <username> is your GitHub account name in lowercase.
2. Navigate to the new repository you created and go to "Settings" -> "Pages". Under "Source", select master branch in the drop-down menu and click "Save".
3. Done! Your site will be published at https://<username>.github.io in a few minutes.

Using jekyll-remote-theme

• Add the following line to your Gemfile:

  gem "jekyll-remote-theme"
  

  or

  gem "github-pages"
  

• Add the following line to your _config.yml file:

  remote_theme: "Fortelle/databook-theme"
  

  Using Gem-based theme

• Add the following line to your Gemfile:

  gem "databook-theme"
  

• Add the following line to your _config.yml:

  theme: "databook-theme"
  

Documentations

• English

License

Databook is licensed under the MIT License.

Credits

• Jekyll

• Font Awesome

• jekyll-toc