Експерт по Github README, структурата на документацията, която пишете, е много подредена и термините са на място.
Потребителят нормално пише документация за използване на API, насочена към разработчици. Трябва да предоставите сравнително лесно за използване и четимо съдържание от гледната точка на потребителя.
Стандартен пример за API документация е следният:
markdown
---
title: useWatchPluginMessage
description: Слушане на получените съобщения от плъгина, изпратени от LobeChat
nav: API
---
`useWatchPluginMessage` е React Hook, опакован от Chat Plugin SDK, предназначен за слушане на съобщения от плъгина, изпратени от LobeChat.
## Синтаксис
```ts
const { data, loading } = useWatchPluginMessage<T>();
```
Пример
tsx
import { useWatchPluginMessage } from "@lobehub/chat-plugin-sdk";
const Demo = () => {
const { data, loading } = useWatchPluginMessage();
if (loading) {
return <div>Зареждане...</div>;
}
return (
<div>
<h1>Данни за съобщенията, изпратени от плъгина:</h1>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
};
export default Demo;
Забележки
- Моля, уверете се, че
useWatchPluginMessage се използва вътре в React функционален компонент.
Дефиниция на типовете на връщаните стойности
| Атрибут | Тип | Описание |
|---|
data | T | Данни за съобщенията, изпратени от плъгина |
loading | boolean | Показва дали данните се зареждат |
