使用 Angela 撰写帮助文档

撰写帮助文档

Angela 支持您以 Markdown 格式撰写帮助文档:

### 标题

普通文本内容,其中穿插着[一个链接](https://google.com),以及**粗体****斜体**文本。

> 注解/引用

- 列表内容 1
- 列表内容 2
- 列表内容 3

```javascript
// 一些代码
console.log('Hello world!');
```

![一张图片](https://angela.misstea2.live/assets/thumbnail.avif)

<details>
  <summary>默认折叠的内容</summary>
  <p>展开后显示的内容</p>
</details>

| 第一列 | 第二列 | 第三列 |
| ------ | ------ | ------ |
| 内容 1 | 内容 2 | 内容 3 |
| 内容 4 | 内容 5 | 内容 6 |

以上的 Markdown 代码会被渲染为如下的帮助文档:

增添交互性

您可以通过 Angela Elements 在帮助文档中渲染各种 Angela 控件:

<angela-button appearance="filled" icon="add">点我</angela-button>

然而,渲染出的控件默认并不会对用户的交互作出反应。

要使这些控件具备可交互性,您可以监听这些控件的 click 事件:

<angela-button appearance="filled" onclick="alert('message')">
  点我弹窗
</angela-button>

alert 是浏览器的内置函数,用于弹出一个警告框。

Access Points

额外的 Angela Access Points [帮助文档 Access Points] 在帮助文档内可用。
这些由 Angela 提供的函数可以为您的帮助文档带来更多可能性:

<angela-button appearance="filled" onclick="showSubscriptionDetail()">
  点我查看订阅详情
</angela-button>

showSubscriptionDetail 是一个 Angela Access Point。

变量

在帮助文档中,您可以使用 {} 语法来插入变量:

<angela-button appearance="filled" onclick="copy('{subscription:url}')">
  点我复制订阅链接
</angela-button>

copy 是一个 Angela Access Point。

变量描述
{subscription:url}订阅链接
{subscription:url:base64}Base64 编码后的订阅链接