wechaty.js.org

https://wechaty.js.org is the official Wechaty website for publishing latest news, blog posts, and documentation from our open source community.

How to post a blog

1. Fork it
2. Syncing your fork
3. Create your blog branch (git checkout -b your-blog)
4. Write your blog in markdown
5. Add your blog to jekyll/_post folder
6. Add related image to jekyll/assets folder (under $YEAR/$MONTH-your-blog-slug/ directory to contain your images)
7. Add your info into jekyll/_contributors/your_github_id.md
8. Commit your changes (git commit -am "${YOUR_BLOG_TITLE")
9. Push to the branch
10. Create new Pull Request
11. Sign the CLA
12. Wait for pass the GitHub Action CI, or fix whatever to make sure CI turns green
13. Wait for @wechaty/editors to review

That's it!

Contribution Guidelines

1. Add Blog Header

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

Example as follows:

---
title: "'Score Your Face Photo' a ML&Wechaty practice"
author: your_github_username
image: your_teaser_image_path
---

<One line abstract for your blog post>

<Your beautiful blog post contents...>

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. No Chinese should be use in all filenames.
• 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 /jekyll/assets/${YEAR}/$MONTH-your-blog-slug/ directory.

4. Just Commit Related Files

Please do not commit unrelated files.

5. Add Videos or pdf

Example

{% include iframe.html src="https://www.youtube.com/watch?v=3eq8wJfCAWs" %}

or

{% include iframe.html src="/assets/2020/qijibot/final.pdf" %}

see more： Add iframe to wechaty blog

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

Preview

Run the Jekyll localhost for blog preview.

0. Prerequisites

Follow in the official instruction to install jekyll in your local jekyll quickstart

1. Install Jekyll by Hand

Run the Jekyll at localhost for blog preview. (It would be easier for a Ruby expert.)

make install
cd jekyll
make serve

2. Preview the Blog

Go to http://127.0.0.1:4000/blog/ , you can preview the blog successfully!

Welcome to contribute

Why contribute?

As an open source product, Wechaty thrives from contributions of community members. Whatever your skill set is, there is a lot you can do to help us make Wechaty better! So start forking!

At the same time, we also meet up offline all over the world, here is some activities:

• Wechaty Contributor Dinner
• The memorabilia of The First Chatie WWDC Party
• Shanghai WWDC - Wechaty Worldwide Developers Conference
• Wechaty Contributor Dinner with Data Girls
• Wechaty Country Wide Developer Conference
• .....

How to contribute docs?

• Fork this repo
• Create your doc branch: git checkout -b doc
• Write this doc in markdown
• Commit your changes git commit -am 'doc comment'
• Push to the branch
• Create new Pull Request

Resources

• Migrating from gitbook to docsify.js
• Integrating GitBook with JSDoc to Document Your Open Source Project
• Markdown Linting Rules Documents

Writers

To get to know all our writers, see https://github.com/wechaty/wechaty.js.org/graphs/contributors

Maintainers

1. @lijiarui, Rui LI, Microsoft AI MVP, Founder & CEO of Juzi.BOT (YC W19 Alumni)
2. @huan, Huan LI, Tencent TVP of Chatbot, <[email protected]>
3. @wj-Mcat, Jingjing WU, Author of Python Wechaty

And wechaty/contributors

Copyright & License

• Code & Docs © 2016-now Wechaty Contributors https://github.com/wechaty
• Code released under the Apache-2.0 License
• Docs released under Creative Commons