content/zh/design/content_posts.md · 薛蒙恩/blog

# Posts
This file is to explain in which way the content of the blogs are stored and read by the blog system.

## What is supported in the blog
A blog can include many formats of information, like text, pictures, videos, animations or others.

This blog is designed to support the following formats:

1. text
2. static picture
3. links
4. animation

## Folder design
The content of blogs are under ./content

```
|__ _example     --list the some blog examples
|__ guidance     --house the guidance to post and maintain the blogs
|__ post         --house all the final posts
   |__ author_1  --house the blogs by authors' gitee ID, and each author need create your own foler by your id.
   |__ author_2  --house the blogs by authors' gitee ID

```

## Post content design
### File name
To create a post, add a file to your _post/author_1/_ directory with the following format:

```
YEAR-MONTH-DAY-title.MARKUP
```
Where YEAR is a four-digit number, MONTH and DAY are both two-digit numbers, and MARKUP is the file extension representing the format used in the file. For example, the following are examples of valid post filenames:
```
2020-01-01-new-years-is-coming.md
2020-02-15-how-to-write-a-blog.md
```

### File headers
Functionally, the post should support categories, archives, title, date, brief description, thus the file headers should be as below.
```
+++
title = ""
date = "yyyy-mm-dd"
tags = ["aaaa", "bbbb", "cccc"]
archives = "yyyy-mm"  //by months
author = "name of author"
summary = ""
+++
```

### Including resources

At some point, you’ll want to include images, downloads, or other digital assets along with your text content.

You can put the resources in the same folder as your text file's, and name the resources as 
```
YEAR-MONTH-DAY-title-NN.MARKUP
```
Where the YEAR, MONTH, DAY, and title are the same as your blog file, and NN is the serial number of the pictures, like 01, 02 and so on. The MARKUP is the file extension, and for pictures it is recommended to use png.
The following are one example.
```
2020-01-01-new-years-is-coming.md
2020-01-01-new-years-is-coming-01.png
2020-01-01-new-years-is-coming-02.gif
2020-01-01-new-years-is-coming-03.pdf
```
Then, from within any post, they can be linked to using the site’s root as the path for the asset to include. Here are some simple examples in Markdown:

Including an image asset in a post:
```
... which is shown in the screenshot below:
![The architecture](/content/post/author1/2020-01-01-new-years-is-coming-01.png)
```

Linking to a PDF for readers to download:
```
... you can [get the PDF](/content/post/yyyymm/2020-01-01-new-years-is-coming-03.pdf) directly.
```
Linking to a url for readers to visit:
```
... you can [read more](<https://gitee.com/opengauss/>).
```

## Thanks
The content above refered to <https://jekyllrb.com/docs/posts/#the-posts-folder>.

薛蒙恩/blog

About

Releases

Contributors

Activities