wechaty.js.org

https://wechaty.js.org is the official wechaty homepage 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 _post folder
6. Add related image to assets folder (create a $MONTH-your-blog-slug/ directory to contain your images)
7. Add your info into _developers/your_github_id.md
8. Commit your changes (git commit -am 'added a blog')
9. Push to the branch
10. Create new Pull Request

Done!~

Contribution Guidelines

1. Add Blog Header

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

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
• 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

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

6. Add links to anchor in paragraph

The titles in markdown files will be added an anchor automatically, you can use that to add your own anchor links. And here is some of the rules how the blog generate the anchor:

• convert the title directly to anchor
• spaces will be replaced by dash -
• /, &, ? and . will be eliminated
• Chinese character will be kept in the anchor

Example

Say you have a title as ### 我是? a title.bat. Then you will get the anchor generated as 我是-a-titlebat. And you can use the generated anchor to implement your own links. Like this:

[奇妙的Link](#我是-a-titlebat)

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

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

More Contribution

See more in: Welcome to contribute

Contact [email protected] to learn more

Markdown Linting Rules

Markdown Linting Rules Documents

Resources

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

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]>

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