You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To submit a blog post for publication on [wechaty.js.org](https://wechaty.js.org), you can follow the steps below.
27
-
28
-
1. Fork this repository. If you don't know what is meant by forking a repository, read about it [here](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)
29
-
2. Clone the forked repository to your local machine. If you don't know how to do that, [this article](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) explains it well
30
-
3. 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](https://help.github.com/cn/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)
31
-
4. We prefer using [gitHub flow](https://guides.github.com/introduction/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
32
-
5. Create a markdown file in [jekyll/\_posts](./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`
33
-
6. 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](https://guides.github.com/features/mastering-markdown/)
34
-
7. Add related images to [jekyll/assets](./jekyll/assets) folder under `$YEAR/$MONTH-your-blog-slug/` directory
35
-
8. Add your info into `jekyll/_contributors/your_github_id.md`
36
-
9. Commit your changes using the command `git commit -am "YOUR_BLOG_TITLE"`. `YOUR_BLOG_TITLE` is the title of your blog
37
-
10. Push your branch to github using the command `git push origin name-of-blog-branch`.
38
-
11. Create new Pull Request(PR)
39
-
12. Sign the [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement)
40
-
13. 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
41
-
14. Wait for @wechaty/editors to review your PR
42
-
43
-
That's it!
44
-
45
-
## Guidelines For Writing a Blog Post
46
-
47
-
### 1. Your blog post should have a Header
48
-
49
-
The header of your blog post should have a title, author and image.
50
-
51
-
This is illustrated in the example below:
52
-
53
-
```yaml
54
-
---
55
-
title: "'Score Your Face Photo' a ML&Wechaty practice"
56
-
author: your_github_username
57
-
image: your_teaser_image_path
58
-
---
59
-
<One line abstract for your blog post>
60
-
61
-
<Your beautiful blog post contents...>
62
-
```
63
-
64
-
### 2. Writing Style
65
-
66
-
- 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.
67
-
- Find a good image for the blog to make it more beautiful.
68
-
- You should embed photos and videos before publishing, save all external files to the `/jekyll/assets/${YEAR}/$MONTH-your-blog-slug/` directory.
69
-
70
-
### 3. Do Not Commit Unrelated Files
71
-
72
-
Please do not commit unrelated files. It will keep things tidy and make it easier to review your PR.
73
-
74
-
### 4. How To Add Videos and PDFs To Your Blog Post
75
-
76
-
You can add videos and PDFs to your blog post by using the syntax below.
77
-
78
-
Example of how to add video or pdf
79
-
80
-
```html
81
-
{% include iframe.html src="https://www.youtube.com/watch?v=3eq8wJfCAWs" %}
82
-
```
83
-
84
-
or
85
-
86
-
```html
87
-
{% include iframe.html src="/assets/2020/qijibot/final.pdf" %}
88
-
```
89
-
90
-
You can read more at： [Add iframe to wechaty blog](https://wechaty.js.org/2020/08/24/add-video-to-wechaty-blog/)
91
-
92
24
## How To Run Tests
93
25
94
26
In order to make sure your changes have not broken anything, you can run the following commands before pushing your changes to gitHub.
@@ -98,27 +30,6 @@ npm install
98
30
npm test
99
31
```
100
32
101
-
## How To Preview Your changes
102
-
103
-
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](https://jekyllrb.com/docs/) instructions to install jekyll.
104
-
105
-
### 1. Install Jekyll by Hand
106
-
107
-
Run Jekyll at localhost to preview your blog post by running the commands below.
108
-
109
-
```sh
110
-
make install
111
-
cd jekyll; make serve # or either run `./scripts/jekyll-serve.sh` for a fresh new start by cleaning cache
112
-
```
113
-
114
-
### 2. Preview the Blog
115
-
116
-
You can view the blog by navigating to <http://127.0.0.1:4000/blog/> in your browser
117
-
118
-
## How To Make Other Contributions
119
-
120
-
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.
121
-
122
33
### Why contribute?
123
34
124
35
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!
@@ -173,7 +84,11 @@ To get to know all our writers, see <https://github.com/wechaty/wechaty.js.org/g
173
84
174
85
## History
175
86
176
-
### main v0.9 (Aug 23, 2021)
87
+
### main v0.10 (Apr 1, 2022)
88
+
89
+
Split docusaurus repo from the mixed repo with Jekyll ([Issue wechaty/wechaty.js.org#1](https://github.com/wechaty/wechaty.js.org/issues/1))
90
+
91
+
### v0.9 (Aug 23, 2021)
177
92
178
93
1. Add OpenAPI Specification docs at <https://wechaty.js.org/docs/openapi/> ([#1218](https://github.com/wechaty/wechaty.js.org/issues/1218))
179
94
@@ -194,7 +109,6 @@ Init version
194
109
195
110
1.[@lijiarui](https://github.com/lijiarui), [Rui LI](https://wechaty.js.org/contributors/lijiarui), Microsoft AI MVP, Founder & CEO of Juzi.BOT (YC W19 Alumni)
196
111
1.[@huan](https://github.com/huan), [Huan LI](https://wechaty.js.org/contributors/huan), Tencent TVP of Chatbot, \<[email protected]\>
197
-
1.[@wj-Mcat](https://github.com/wj-Mcat), [Jingjing WU](https://wechaty.js.org/contributors/wj-mcat), Author of [Python Wechaty](https://github.com/wechaty/python-wechaty)
198
112
199
113
And [wechaty/contributors](https://github.com/orgs/wechaty/teams/contributors/members)
0 commit comments