https://wechaty.js.org is the official wechaty homepage for publishing latest news, blog posts, and documentation from our open source community.
- Fork it
- Syncing your fork
- Create your blog branch (git checkout -b your-blog)
- Write your blog in markdown
- Add your blog to
_postfolder - Add related image to
assetsfolder (create a$MONTH-your-blog-slug/directory to contain your images) - Add your info into
_developers/your_github_id.md - Commit your changes (git commit -am 'added a blog')
- Push to the branch
- Create new Pull Request
Done!~
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...>- Keep all filenames & url as lowercase, and use
-to connect words instead of space. e.g.2017-10-06-wechat-pc-impactorinstead 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
Please do not commit unrelated files.
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
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
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)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 testRun the Jekyll localhost for blog preview.
Follow in the official instruction to install jekyll in your local jekyll quickstart
Run the Jekyll at localhost for blog preview. (It would be easier for a Ruby expert.)
make install
cd jekyll
make serveGo to http://127.0.0.1:4000/blog/ , you can preview the blog successfully!
See more: jekyll for wechaty.js.org
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
- .....
- 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
See more in: Welcome to contribute
Contact rui@chatie.io to learn more
Markdown Linting Rules Documents
- Migrating from gitbook to docsify.js
- Integrating GitBook with JSDoc to Document Your Open Source Project
To get to know all our writers, see https://github.com/wechaty/wechaty.js.org/graphs/contributors
- @lijiarui, Rui LI, Microsoft AI MVP, Founder & CEO of Juzi.BOT (YC W19 Alumni)
- @huan, Huan LI, Tencent TVP of Chatbot, <zixia@zixia.net>
- @wj-Mcat, Jingjing WU, Author of Python Wechaty
- Code & Docs © 2016-now Wechaty Contributors https://github.com/wechaty
- Code released under the Apache-2.0 License
- Docs released under Creative Commons