Skip to content

Commit

Permalink
docs: update integration doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sunshinesmilelk committed Feb 10, 2025
1 parent f967dcf commit bcb67bf
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 4 deletions.
29 changes: 27 additions & 2 deletions apps/docs/docs/integration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,32 @@ In the `tsconfig.json` file at the project root, add the following configuration
},
```

### Integrate Lab Development Environment
### Integrated Import

We provide two ways to introduce the integration: the Lab R&D environment and the Notebook editor.
The package `'@difizen/libro-lab'` includes both forms—the Lab R&D environment corresponds to `'@difizen/libro-lab'`, while the Notebook editor corresponds to `'@difizen/libro-jupyter'`.

You can import them in the following two ways:

- **Method 1**

Import from the `'@difizen/libro'` package:

```typescript
import { LibroLab } from '@difizen/libro';

const { LibroLabModule } = LibroLab;
```

- **Method 2**

Import from the `'@difizen/libro-lab'` package:

```typescript
import { LibroLabModule } from '@difizen/libro-lab';
```

#### Integrate Lab Development Environment

<img src="https://raw.githubusercontent.com/wiki/difizen/libro/assets/libro_en.png" width="1200" />

Expand Down Expand Up @@ -119,7 +144,7 @@ const App = (): JSX.Element => {
export default App;
```

### Integrate Notebook Editor
#### Integrate Notebook Editor

<img src="https://raw.githubusercontent.com/wiki/difizen/libro/assets/libro_editor.png" width="1000" />

Expand Down
29 changes: 27 additions & 2 deletions apps/docs/docs/integration/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,32 @@ export default defineConfig({
},
```

### 集成 Lab 研发环境
### 集成引入

我们提供了 Lab 研发环境、Notebook 编辑器两种形态的方式引入。
`'@difizen/libro-lab'`,包含了两种形态的内容,Lab 研发环境,对应的包为 `'@difizen/libro-lab'`, Notebook 编辑器对应的包为 `'@difizen/libro-jupyter'`

可以通过如下两个方式导入:

- 方式一

`'@difizen/libro'` 包中引入:

```typescript
import { LibroLab } from '@difizen/libro';

const { LibroLabModule } = LibroLab;
```

- 方式二

`'@difizen/libro-lab'` 包中引入:

```typescript
import { LibroLabModule } from '@difizen/libro-lab';
```

#### 集成 Lab 研发环境

<img
src="https://raw.githubusercontent.com/wiki/difizen/libro/assets/libro.png"
Expand Down Expand Up @@ -125,7 +150,7 @@ export default App;

```

### 集成 Notebook 编辑器
#### 集成 Notebook 编辑器

<img
src="https://raw.githubusercontent.com/wiki/difizen/libro/assets/libro_editor_zh.png"
Expand Down

0 comments on commit bcb67bf

Please sign in to comment.