neatstudio / blog

Chatie Official Blog

blog.chatie.io

Chatie Official Blog

HOW TO POST BLOG

1. Fork it
2. Create your blog branch (git checkout -b your-blog)
3. Write your blog in markdown
4. Add your blog to _post folder
5. Add related image to assets folder
6. Commit your changes (git commit -am 'added a blog')
7. Push to the branch
8. Create new Pull Request

Done!~

CONTRIBUTE GUIDELINE

1. Add Blog Header

All blog should has title, author, date...

Example as follows:

---

 title: "'Score Your Face Photo' a ML&Wechaty practice"
 date: 2017-09-18 09:00 +0800
 author: huyingxi
 ---

 > Author: [@huyingxi](https://github.com/huyingxi/wechaty_selfie) enjoying ML&Wechaty at BUPT

2. Writing Style

• Keep all filenames & url as lowercase, and use - to connect words instead of space. e.g. 2017-10-06-wechat-pc-impactor instead of 2017-10-06-WeChat PC Impactor
• Find a good image for the blog to make it more beautiful.
• Embed the photo & video before publishing, save all external file to the blog /assets/2018 directory.

see more: Do not include Date in URL

3. Add <!--more--> Section

Add <!--more--> section for your abstract part, it will show on the blog homepage, or the blog homepage will show all your blog content.

4. Just Commit Related Files

Please do not commit unrelated files.

5. Add Videos

Example

<iframe width="560" height="315" src="https://www.youtube.com/embed/3eq8wJfCAWs" frameborder="0" allowfullscreen></iframe>

Usage

Jekyll

Install all the Jekyll requirements and run it at localhost for blog preview.

1 Use Docker Compose

This is the recommended way for new users to easy getting started

make docker

2 Install Jekyll by Hand

You should not use this way except you are a Ruby expert.

make install
make serve

Test

In order to make sure everything(file name, file size, etc) is ok, you can run the following command to check them before git push.

npm install
npm test

OTHERS

JEKYLL THEME

minima: https://github.com/jekyll/minima

AUTHOR

Huan LI (李卓桓) [e-mail]

COPYRIGHT & LICENSE

• Code & Docs © 2019 - now Huan LI [e-mail]
• Code released under the Apache-2.0 License
• Docs released under Creative Commons