Guidance to Post a Blog

Preparation

  1. Refer to http://git.mydoc.io/?t=179267 to register Gitee account.

  2. Set your primary mail box in gitee settings https://gitee.com/profile/emails.

  3. Sign your CLA in https://openlookeng.io/signcla.html.

  4. Prepare your git environment refering to http://git.mydoc.io/?t=180692.

Understand blog format

The openLooKeng blog is written in markdown format.

You can read https://gitee.com/openlookeng/website/tree/master/docs/blog_design.md to get understand how the blog is designed.

The head includes the following information:

+++
title = "Sample Post"
date = "2020-03-03"
tags = ["Sample", "ABC", "cccc"]
archives = "2020-03"
author = "openLooKeng Blog Author"
description = "Just about everything you'll need to style in the theme: headings, paragraphs, blockquotes, tables, code blocks, and more."
+++

Here you can edit your blog. 

Tips: you can copy docs/blog_example/2020-03-03-sample-post.md to your folder and edit it.

Post your blog

The blog posting follows the pull request of Gitee.

  1. Fork openLooKeng blog project https://gitee.com/openlookeng/website to your own gitee. Refer to http://git.mydoc.io/?t=153749 for detailed guidance.

  2. Clone the code to your local environment.

git clone https://gitee.com/<your-gitee-id>/website
  1. Create a branch
git checkout -b <branch-name>
  1. Create a folder in the website floder If you are going to post a blog in English, the content/en-us/blog is your work path.

And if you are going to post a blog in Chinese, the content/zh-cn/blog is your work path.

Assume that you are preparing a English blog.

cd content/en-us/post
mkdir <your-gitee-id>
cd <your-gitee-id>
touch YEAR-MONTH-DAY-title.md

And 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

To embed an image in your post, use HTML <img> tag and enter name of the image as src attribute:

<img src = "2020-01-01-new-years-is-coming-01.png">
  1. Commit your post
git add <file-path>
git commit -m "<message>"
git push origin <branch-name>:<branch-name>
  1. Refer to http://git.mydoc.io/?t=153749 to submit your Pull Request

  2. Wait for reviewing and merging.