3.7 KiB
title | author | date | categories | tags | |||
---|---|---|---|---|---|---|---|
Writing a New Post | Cotes Chung | 2019-08-08 14:10:00 +0800 |
|
|
Naming and Path
Create a new file named YYYY-MM-DD-TITLE.EXTENSION
and put it in the _post/
of the root directory. Please note that the EXTENSION
must be one of md
and markdown
. From v2.4.1
, you can create sub-directories under _posts/
to categorize posts.
Front Matter
Basically, you need to fill the Front Matter as below at the top of the post:
---
title: TITLE
date: YYYY-MM-DD HH:MM:SS +/-TTTT
categories: [TOP_CATEGORIE, SUB_CATEGORIE]
tags: [TAG] # TAG names should always be lowercase
---
Note
: The posts' layout has been set to
post
by default, so there is no need to add the variable layout in Front Matter block.
Timezone of date
In order to accurately record the release date of a post, you should not only setup the timezone
of _config.yml
but also provide the the post's timezone in field date
of its Front Matter block. Format: +/-TTTT
, e.g. +0800
.
Categories and Tags
The categories
of each post is designed to contain up to two elements, and the number of elements in tags
can be zero to infinity. For instance:
categories: [Animal, Insect]
tags: [bee]
Table of Contents
By default, the Table of Contents (TOC) is displayed on the right panel of the post. If you want to turn it off globally, go to _config.yml
and set the value of variable toc
to false
. If you want to turn off TOC for specific post, add the following to post's Front Matter:
---
toc: false
---
Comments
Similar to TOC, the Disqus comments is loaded by default in each post, and the global switch is defined by variable comments
in file _config.yml
. If you want to close the comment for specific post, add the following to the Front Matter of the post:
---
comments: false
---
Mathematics
For website performance reasons, the mathematical feature won't be loaded by default. But it can be enabled by:
---
math: true
---
Preview Image
If you want to add an image to the top of the post contents, specify the url for the image by:
---
image: /path/to/image-file
---
Pinned Posts
You can pin one or more posts to the top of the home page, and the fixed posts are sorted in reverse order according to their release date. Enable by:
---
pin: true
---
Code Block
Markdown symbols ```
can easily create a code block as following examples.
This is a common code snippet, without syntax highlight and line number.
Specific Language
Using ```language
you will get code snippets with line numbers and syntax highlight.
Note
: The Jekyll style
{% raw %}{%{% endraw %} highlight LANGUAGE {% raw %}%}{% endraw %}
or{% raw %}{%{% endraw %} highlight LANGUAGE linenos {% raw %}%}{% endraw %}
are not allowed to be used in this theme !
# Yaml code snippet
items:
- part_no: A4786
descrip: Water Bucket (Filled)
price: 1.47
quantity: 4
Liquid Codes
If you want to display the Liquid snippet, surround the liquid code with {% raw %}{%{% endraw %} raw {%raw%}%}{%endraw%}
and {% raw %}{%{% endraw %} endraw {%raw%}%}{%endraw%}
.
{% raw %}
{% if product.title contains 'Pack' %}
This product's title contains the word Pack.
{% endif %}
{% endraw %}
Learn More
For more knowledge about Jekyll posts, visit the Jekyll Docs: Posts.