jekyll

Wechaty Official Website for News, Blogs, Contributor Profiles, Powered by Jekyll.

Wechaty Organization Website

Repository for the Wechaty Organization Website, a resource for the Wechaty Organization. It is the official Wechaty website for publishing latest news, blog posts, and documentation from our open source community.

Tutorials

How To Post a Blog

To submit a blog post for publication on wechaty.js.org, you can follow the steps below.

Fork this repository. If you don't know what is meant by forking a repository, read about it here
Clone the forked repository to your local machine. If you don't know how to do that, this article explains it well
Make sure your forked repository is in sync with the main repository. If you don't know how to sync a forked repository,read about it in this article
We prefer using gitHub flow. Therefore start by creating a branch for your blog using the command git checkout -b name-of-blog-branch. Give the branch a meaningful name
Create a markdown file in jekyll/_posts folder. The file name should follow the format YYYY-MM-DD-your-blog-slug.md. For example 2016-12-03-welcome-to-wechaty.md
Write your blog in markdown in the file you created in the previous step. If you are not familiar with markdown syntax, you can learn it here
Add related images to jekyll/assets folder under $YEAR/$MONTH-your-blog-slug/ directory
Add your info into jekyll/_contributors/your_github_id.md
Use mermaid: URL
Commit your changes using the command git commit -am "YOUR_BLOG_TITLE". YOUR_BLOG_TITLE is the title of your blog
Push your branch to github using the command git push origin name-of-blog-branch.
Create new Pull Request(PR)
Sign the CLA
Wait for the continuous integration workflow run to finish. If it is failing, fix whatever is making it to fail so that CI turns green
Wait for @wechaty/editors to review your PR

That's it!

Guidelines For Writing a Blog Post

1. Your blog post should have a Header

The header of your blog post should have a title, author and image.

This is illustrated in the example below:

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

You should keep all filenames and URLs as lowercase. Use - character between words instead of space when creating a new file or directory. e.g. 2017-10-06-wechat-pc-impactor instead of 2017-10-06-WeChat PC Impactor. No Chinese should be used in any filename.
Find a good image for the blog to make it more beautiful.
You should embed photos and videos before publishing, save all external files to the /jekyll/assets/${YEAR}/$MONTH-your-blog-slug/ directory.

3. Do Not Commit Unrelated Files

Please do not commit unrelated files. It will keep things tidy and make it easier to review your PR.

4. How To Add Videos and PDFs To Your Blog Post

You can add videos and PDFs to your blog post by using the syntax below.

Example of how to add video or pdf

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

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

You can read more at： Add iframe to wechaty blog

How To Run Tests

In order to make sure your changes have not broken anything, you can run the following commands before pushing your changes to gitHub.

npm install
npm test

How To Preview Your changes

If you want to preview your blog post or changes on localhost, you need to have Jekyll installed in your machine. You can follow the jekyll quickstart instructions to install jekyll.

1. Install Jekyll by Hand

Run Jekyll at localhost to preview your blog post by running the commands below.

make install
cd jekyll; make serve # or either run `./scripts/jekyll-serve.sh` for a fresh new start by cleaning cache

2. Preview the Blog

You can view the blog by navigating to http://127.0.0.1:4000/blog/ in your browser

How To Make Other Contributions

If you are not interested in writing a blog post but would still love to make a contribution, you are still welcome. We are delighted to have you around.

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 are some activities you are invited to join if you are interested:

How to Run Locally

Clone this repository: git clone "https://github.com/wechaty/wechaty.js.org"
On the terminal navigate to the root directory cd wechaty.js.org
Run the commands :
1. npm install
2. npm run docusaurus:build
3. npm run docusaurus:serve
The site will be running locally on http://localhost:3000