wechaty.github.io
HOW TO POST BLOG
- Fork it
- Syncing your fork
- Create your blog branch (git checkout -b your-blog)
- Write your blog in markdown
- Add your blog to
_post
folder - Add related image to
assets
folder - Add your info into
_data/authors.yml
- Commit your changes (git commit -am 'added a blog')
- Push to the branch
- Create new Pull Request
Done!~
CONTRIBUTE GUIDELINE
1. Add Blog Header
All blog should has title, author, date, teaser...
Example as follows:
---
title: "'Score Your Face Photo' a ML&Wechaty practice"
date: 2017-09-18 09:00 +0800
author: your_github_username
header:
teaser: your_teaser_image_path
---
<!-- markdownlint-disable -->
> Author: [@your_github_username](https://github.com/your_github_username) your one-line bio at here
> Code: [@yourcode](your_code_path)
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 of2017-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/${current_year}
directory.
see more: Do not include Date in URL
<!--more-->
Section
3. Add 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
Install Jekyll by Hand
2 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 (李卓桓), Tencent TVP of Chatbot, <zixia@zixia.net>
Copyright & License
- Code & Docs © 2019-now Huan LI <zixia@zixia.net>
- Code released under the Apache-2.0 License
- Docs released under Creative Commons