# struct-writing-sdk

> 智能创作结构化写作sdk

Latest version **0.0.6** (published 2022-07-05) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install struct-writing-sdk
pnpm add struct-writing-sdk
yarn add struct-writing-sdk
bun add struct-writing-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2022-07-05 |
| First published | 2022-04-24 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 42 |
| Unpacked size | 3.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | lizhenghui |
| Maintainers | lizhenghui01 |

## Links

- npm: https://www.npmjs.com/package/struct-writing-sdk
- npm.io page: https://npm.io/package/struct-writing-sdk

## Dependencies (42)

- [antd](https://npm.io/package/antd.md) ^4.17.3
- [mobx](https://npm.io/package/mobx.md) ^6.4.2
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [bytes](https://npm.io/package/bytes.md) ^3.1.2
- [dayjs](https://npm.io/package/dayjs.md) ^1.10.8
- [react](https://npm.io/package/react.md) ^17.0.2
- [slate](https://npm.io/package/slate.md) ^0.76.0
- [react-is](https://npm.io/package/react-is.md) ^17.0.0
- [video.js](https://npm.io/package/video.js.md) ^7.18.1
- [is-hotkey](https://npm.io/package/is-hotkey.md) ^0.2.0
- [js-cookie](https://npm.io/package/js-cookie.md) ^3.0.1
- [react-dom](https://npm.io/package/react-dom.md) ^17.0.2
- [classnames](https://npm.io/package/classnames.md) ^2.3.1
- [file-saver](https://npm.io/package/file-saver.md) ^2.0.5
- [mobx-react](https://npm.io/package/mobx-react.md) ^7.3.0
- [mobx-utils](https://npm.io/package/mobx-utils.md) ^6.0.5
- [superagent](https://npm.io/package/superagent.md) ^7.1.1
- [lodash.noop](https://npm.io/package/lodash.noop.md) ^3.0.1
- [slate-react](https://npm.io/package/slate-react.md) ^0.76.0
- [normalize.css](https://npm.io/package/normalize.css.md) ^8.0.1
- [slate-history](https://npm.io/package/slate-history.md) ^0.66.0
- [@popperjs/core](https://npm.io/package/@popperjs/core.md) ^2.11.4
- [@tippyjs/react](https://npm.io/package/@tippyjs/react.md) ^4.2.6
- [tiny-invariant](https://npm.io/package/tiny-invariant.md) ^1.2.0
- [lodash.debounce](https://npm.io/package/lodash.debounce.md) ^4.0.8
- [lodash.uniqueid](https://npm.io/package/lodash.uniqueid.md) ^4.0.1
- [path-browserify](https://npm.io/package/path-browserify.md) ^1.0.1
- [@ant-design/icons](https://npm.io/package/@ant-design/icons.md) ^4.7.0
- [@udecode/plate-ui](https://npm.io/package/@udecode/plate-ui.md) ^10.5.1
- [slate-hyperscript](https://npm.io/package/slate-hyperscript.md) ^0.67.0
- [styled-components](https://npm.io/package/styled-components.md) ^5.3.5
- [@baidu/mobx-x-flow](https://npm.io/package/@baidu/mobx-x-flow.md) ^0.2.0
- [@loadable/component](https://npm.io/package/@loadable/component.md) ^5.15.2
- [@udecode/plate-core](https://npm.io/package/@udecode/plate-core.md) ^10.5.0
- [@baidu/ai-cape-event](https://npm.io/package/@baidu/ai-cape-event.md) ^1.1.0
- [@udecode/plate-paragraph](https://npm.io/package/@udecode/plate-paragraph.md) ^10.4.2
- [@udecode/plate-ui-toolbar](https://npm.io/package/@udecode/plate-ui-toolbar.md) ^10.5.0
- [antd-dayjs-webpack-plugin](https://npm.io/package/antd-dayjs-webpack-plugin.md) ^1.0.6
- [@baidu/ai-cape-react-icons](https://npm.io/package/@baidu/ai-cape-react-icons.md) ^0.0.21
- [@baidu/bos-simple-uploader](https://npm.io/package/@baidu/bos-simple-uploader.md) ^0.1.0
- [@baidu/ai-cape-common-error](https://npm.io/package/@baidu/ai-cape-common-error.md) ^0.4.1
- [@udecode/plate-styled-components](https://npm.io/package/@udecode/plate-styled-components.md) ^10.5.0

## Recent versions

- 0.0.6 (latest) — 2022-07-05
- 0.0.5 — 2022-04-25
- 0.0.4 — 2022-04-24
- 0.0.3 — 2022-04-24
- 0.0.2 — 2022-04-24
- 0.0.1 — 2022-04-24

## README

# 自定义模版写作 前端接入文档

自定义模版写作前端sdk接入文档

## 接入

有两种接入方式

### npm包接入

1. 安装

  ```shell
  npm install struct-writing-sdk
  ```

2. 使用
   首先在当前页面创建一个id为struct-writing的元素用于挂载实例

  ```html
  <div id="struct-writing"></div>
  ```

  执行包暴露出的`structWritingMount`方法进行实例的挂载，并引入样式文件

  ```js
  import {structWritingMount} from 'struct-writing-sdk';
  import 'struct-writing-sdk/output/static/css/main.css';

  structWritingMount();
  ```


### CDN接入

1. 引入静态资源

  ```html
  <script type="application/javascript" src="https://ai-saas-static.cdn.bcebos.com/struct-writing/output/static/js/main.js"></script>
  <link rel="stylesheet" href="https://ai-saas-static.cdn.bcebos.com/struct-writing/output/static/css/main.css">
  ```

2. 使用
   首先在当前页面创建一个id为struct-writing的元素用于挂载实例

  ```html
  <div id="struct-writing"></div>
  ```

  然后执行在window上挂载的方法进行实例的挂载
   `注：要确保静态资源加载完毕后再执行structWritingMount方法`

  ```js
  window.structWriting.structWritingMount();
  ```

---
_Source: https://npm.io/package/struct-writing-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
