Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a
_config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.
For technical reasons,
_config.yml is NOT reloaded automatically when you use
jekyll serve. If you change this file, please restart the server process.
If you’re using the Ruby gem version of the theme you’ll need this line to activate it:
You can choose these 6 built-in color themes below:
text_color_theme: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
The base hostname and protocol for your site. if you are hosting the site on Github Pages this will be set as the GitHub Pages domain (cname or user domain)1. For example, https://kitian616.github.io or https://tianqi.name if there is cname file.
Jekyll 3.3 overrides this value with url: http://localhost:4000 when running
jekyll serve in a development environment2. You can specifying Jekyll environment3 to production environment by
JEKYLL_ENV=production to avoid this behavior.
The base URL for your site, default to ‘/’. If you are hosting the site on Github Pages this will be set as the project name for project pages if none is set1.
The name of your site.
title: "My Awesome Website"
Use some words to describe your site.
description: > # this means to ignore newlines until "nav_lists:" A website with awesome stories.
Language and Timezone
The language of your site, you can override it with different ones on specific posts, pages by YAML Front Matter4.
|zh||Simplified Chinese, 简体中文|
|zh-Hans||Simplified Chinese, 简体中文|
|zh-Hant||Traditional Chinese, 繁體中文|
Set the time zone for site generation. This sets the TZ environment variable, which Ruby uses to handle time and date creation and manipulation. A list of all available values can be found HERE.
When serving on a local machine, the default time zone is set by your operating system. But when served on a remote host/server, the default time zone depends on the server’s setting or location.5
Author and Social
Information of the site author (a person, a team, an organization or even a cat).
Used to assign a site author.
Username or id of site author’s social networks.
Now we supports Email, Facebook, Twitter, Google Plus, Github, Linkedin, Weibo(微博) and Douban(豆瓣), more to be added.
Depending on your settings, the social network buttons would show on every pages’ footer.
In order for jekyll-github-metadata to know what metadata to fetch it must be able to determine the repository NWO to ask GitHub about.
“NWO” stands for “name with owner.” It is GitHub lingo for the username of the owner of the repository plus a forward slash plus the name of the repository, e.g. ‘kitian616/jekyll-TeXt-theme’, where ‘kitian616’ is the owner and ‘jekyll-TeXt-theme’ is the repository name.
Each post automatically takes the first block of text, from the beginning of the content to the first occurrence of excerpt_separator, and sets it as the post’s excerpt.
The post’s excerpt is show in the articles list in the home layout. There are two excerpt types: text type and html type:
|text||the excerpt are plain text that filters out all non-text elements (such as title, link, list, table, picture, etc.) and only show 350 characters most.|
|html||the excerpt are HTML document just like the content of the article, This will show all the content by default, except adding
excerpt_separator: <!--more--> excerpt_type: text # text (default), html
Elements to use as headings.
toc: selectors: "h1,h2,h3"
To improve the user experience for both reading and writing posts, TeXt made some enhancements for markdown. By default, all the enhancements for markdown is enabled. you need set the settings to true to enable them:
# Mathjax mathjax: true mathjax_autoNumber: true # Mermaid mermaid: true # Chart chart: true
And also you can override it with different ones on specific posts, pages by YAML Front Matter4.
Check Writing Posts for detail usage.
Settings for Jekyll Paginate plugin. to enable pagination for posts on your blog, add a line to the _config.yml file that specifies how many items should be displayed per page:
The number should be the maximum number of Posts you’d like to be displayed per-page in the generated site.
You may also specify the destination of the pagination pages:
paginate_path: /page:num # don't change this unless for special need
If your website is mainly for Chinese, just use BootCDN.
sources: bootcdn # bootcdn (default), unpkg
To use Disqus you’ll need to create an account and shortname. Once you have both update _config.yml to:
disqus: shortname: "your-disqus-shortname"
To use gitalk you need a GitHub application, if you don’t have one, Click here to register a new one. and then update _config.yml to:
gitalk: clientID: "github-application-client-id" clientSecret: "github-application-client-secret" repository: "github-repo" owner: "github-repo-owner" admin: # Github repo owner and collaborators, only these guys can initialize github issues, IT IS A LIST. - "your-github-id" - "the-other-admin-github-id"
For all the above comment systems, you NEED set
key variable in the page’s YAML Front Matter to enable comment on this page, you can find more information HRER.
TeXt use LeanCloud as back-end service. You need create a app on the dashboard, and config the app’s id, key and class name.
The detail guide of LeanCloud will find in Chinese document since LeanCloud haven’t provide an English-language edition.
leancloud: app_id: "your-leanCloud-app-id" app_key: "your-leanCloud-app-key" app_class: "your-leanCloud-app-class"
For all the above pageview statistics, you NEED set
key variable in the page’s YAML Front Matter to enable statistics on this page, you can find more information HRER.
In order to use Google Analytics, set
ga_tracking_id to your Google Analytics tracking code.