Skip to content
This repository has been archived by the owner on Jan 27, 2021. It is now read-only.

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xiazeyu committed May 19, 2018
1 parent af50135 commit a9d0e2d
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 13 deletions.
46 changes: 43 additions & 3 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,55 @@
# Issue

## Description
## Environment 环境信息

Your system version:
您的系统版本:

Your browser version:
您的浏览器版本:

### plugin version 插件版本

hexo-helper-live2d:

> use `npm ls hexo-helper-live2d` to get current plugin's version.
使用 `npm ls hexo-helper-live2d` 来获取当前插件版本.

config in `_config.yml`:
`_config.yml` 中的配置:

```yaml

```

## Description 问题描述

URL:
出现问题的网站地址:

Console output:
控制台输出:

Screenshot(if have):
截图(如果有):

### Expected behavior 预期行为

### Actual behavior 实际行为

### Steps to reproduce the behavior 复现步骤

- [ ] I have alreday read instructions in [CONTRIBUTING](./CONTRIBUTING.md).
我已仔细阅读[CONTRIBUTING](./CONTRIBUTING.md)中的相关内容。
1.

2.

3.

- [ ] I have alreday read instructions in [CONTRIBUTING](CONTRIBUTING.md).
我已仔细阅读[CONTRIBUTING](CONTRIBUTING.md)中的相关内容。

- [ ] I have alreday read instructions in [README](../README.md).
我已仔细阅读[README](../README.zh-CN.md)中的相关内容。

> Change the `[ ]` into `[x]` to show your acceptance.
`[ ]` 变为 `[x]` 来表示你接受了这些问题。
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ Author's original Blog: [https://huaji8.top/post/live2d-plugin-2.0/](https://hua

Install module:

```
```bash

npm install --save hexo-helper-live2d

```

> try `yarn add hexo-helper-live2d` for better installation experience.
Expand Down Expand Up @@ -212,21 +214,21 @@ and type it into `model.use` in `_config.yml` to use it.

#### make your own ones

1. Create an folder, use your node environment run `npm init`, we recommend
- Create an folder, use your node environment run `npm init`, we recommend
you to name it like

`live2d-widget-model-xxx`.

2. Create an `assets` folder in the folder you just created, copy your model
- Create an `assets` folder in the folder you just created, copy your model
files into it.

Here's an example:

[live2d-widget-model-wanko](https://cdn.jsdelivr.net/npm/live2d-widget-model-wanko)

3. Use `npm publish` to publish it.
- Use `npm publish` to publish it.

4. Then use `npm install --save live2d-widget-model-xxx`,
- Then use `npm install --save live2d-widget-model-xxx`,

and you can just type your package name(`live2d-widget-model-wanko`) into `model.use`

Expand Down
12 changes: 7 additions & 5 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@

安装模块:

```
```bash

npm install --save hexo-helper-live2d

```

> 试试 `yarn add hexo-helper-live2d`, 据说高能的yarn会比垃圾npm少很多麻烦呢。
Expand Down Expand Up @@ -207,17 +209,17 @@ live2d:

#### 发布你自己的模型包

1. 新建一个目录, 用你的Node环境执行 `npm init`, 我们推荐您使用 `live2d-widget-model-xxx` 的包名.
- 新建一个目录, 用你的Node环境执行 `npm init`, 我们推荐您使用 `live2d-widget-model-xxx` 的包名.

2. 在刚刚创建的目录下创建 `assets` 子目录, 把你的模型放进去.
- 在刚刚创建的目录下创建 `assets` 子目录, 把你的模型放进去.

示例:

[live2d-widget-model-wanko](https://cdn.jsdelivr.net/npm/live2d-widget-model-wanko)

3. 使用 `npm publish` 来发布.
- 使用 `npm publish` 来发布.

4. 然后使用 `npm install --save live2d-widget-model-xxx` 来安装,
- 然后使用 `npm install --save live2d-widget-model-xxx` 来安装,

然后你就可以通过向 `model.use` 键入包名 (`live2d-widget-model-wanko`) 来使用了.

Expand Down

0 comments on commit a9d0e2d

Please sign in to comment.