Aherman3 api docs add zh

docusaurus/docs/references/overview.mdx

@@ -11,7 +11,7 @@ The reference guide contains the technical description of the machinery. They ar
 
 ## References Index
 
-1. [API References](../api/overview.mdx)
+1. [API References](/api/overview.mdx)
 1. [Polyglot](../polyglot/overview.mdx)
 1. [Puppet Providers](../puppet-providers/overview.mdx)
 1. [Puppet Services](../puppet-services/overview.mdx)

docusaurus/docs/wechaty.mdx

@@ -26,7 +26,7 @@ Wechaty offers out-of-the-box support for the common features you would need for
 
 :::note API References
 
-Learn more functions from [API Reference](./api/overview.mdx) and [How-to Guides](./howto/overview.mdx).
+Learn more functions from [API Reference](/api/overview.mdx) and [How-to Guides](/howto/overview.mdx).
 
 :::
 
@@ -91,7 +91,7 @@ You can build a chatbot with a minimum of 6 lines of code with Wechaty.
 
 :::note Polyglot Wechaty
 
-Read more codes from [Polyglot](./polyglot/overview.mdx).
+Read more codes from [Polyglot](/polyglot/overview.mdx).
 
 :::
 

docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/api/contact-self.md

@@ -0,0 +1,104 @@
+---
+title: ContactSelf
+---
+
+机器人自己的信息将会封装一个ContactSelf 类。这个类继承自 Contact。
+
+## ContactSelf
+
+> 备注：这个类继承自 Contact
+
+**Kind**: global class
+
+* ContactSelf
+  * 实例
+    * contactSelf.avatar\(\[file\]\) ⇒ `Promise <void | FileBox>`
+    * contactSelf.qrcode\(\) ⇒ `Promise <string>`
+    * contactSelf.signature\(signature\) ⇒ `Promise <string>`
+    * contactSelf.name\(\[name\]\) ⇒ `Promise <void> | string`
+
+### contactSelf.avatar\(\[file\]\) ⇒ `Promise <void | FileBox>`
+
+设置机器人的头像
+
+**Kind**: `ContactSelf`的实例方法
+
+| Param | Type |
+| :--- | :--- |
+| \[file\] | `FileBox` |
+
+**示例** _\( GET the avatar for bot, return {Promise&lt;FileBox&gt;}\)_
+
+```javascript
+bot.on('login', async user => {
+  console.log(`user ${user} login`)
+  const file = await user.avatar()
+  const name = file.name
+  await file.toFile(name, true)
+  console.log(`Save bot avatar: ${user.name()} with avatar file: ${name}`)
+})
+
+### contactSelf.qrcode\(\) ⇒ `Promise <string>`
+
+获取机器人的二维码。
+
+**Kind**: `ContactSelf`的实例方法
+
+#### 示例
+
+```javascript
+import { generate } from 'qrcode-terminal'
+bot.on('login', async user => {
+  console.log(`user ${user} login`)
+  const qrcode = await user.qrcode()
+  console.log(`Following is the bot qrcode!`)
+  generate(qrcode, { small: true })
+})
+```
+
+### contactSelf.signature\(signature\) ⇒ `Promise <void>`
+
+修改机器人签名。
+
+**Kind**: `ContactSelf`的实例方法
+
+| Param | Description |
+| :--- | :--- |
+| signature | 机器人要修改的签名内容 |
+
+#### 示例
+
+```javascript
+bot.on('login', async user => {
+  console.log(`user ${user} login`)
+  try {
+    await user.signature(`Signature changed by wechaty on ${new Date()}`)
+  } catch (e) {
+    console.error('change signature failed', e)
+  }
+})
+```
+
+### contactSelf.name\(\[name\]\) ⇒ `Promise<void> | string`
+
+修改机器人昵称。
+
+**Kind**: `ContactSelf`的实例方法
+
+| Param | Description |
+| :--- | :--- |
+| \[name\] | 机器人要修改的昵称内容 |
+
+#### 示例
+
+```javascript
+bot.on('login', async user => {
+  console.log(`user ${user} login`)
+  const oldName = user.name() // get bot name
+  try {
+    await user.name(`${oldName}-${new Date().getTime()}`) // change bot name
+  } catch (e) {
+    console.error('change name failed', e)
+  }
+})
+```