# inula-docdemo

**Repository Path**: LogCreative/inula-docdemo

## Basic Information

- **Project Name**: inula-docdemo
- **Description**: 生成 md 文档中代码片段的 inula 编译结果
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2023-12-13
- **Last Updated**: 2024-01-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# inula-docdemo

#### 介绍
生成 markdown 文档中代码片段的 inula 编译结果

#### 软件架构

![软件架构](img/architecture.png)

1. 对 Markdown 文档进行解析，提取出代码块的内容，并对代码块在新的 Markdown 文档中替换为含有预览的组件。
2. 将代码块内容放入沙箱中，使用最新版本的 openInula 进行编译，对于无法正确编译的示例进行报告，并可与之前的编译结果进行比较报告回归测试结果。
3. 临时替换 Markdown 文档为新文档，构建网站，最后替换回原文档。
4. 集成在 CI 命令中进行部署。

#### 安装教程

```bash
npm install
cd template && npm install && cd ..
cd test && npm install && cd ..
```

#### 使用说明

使用 GPT 需要在按照 `.env.example` 创建 `.env` 文件填写 `OPENAI_API_KEY`，
然后在 `docdemo.config.js` 中将 `gpt` 设置为 `true`。
如果你希望保留缓存结果于 git 上，你需要手动
```
git add -f tmp/demo-cache/*
```
然后再提交。

```bash
npm run start               # 编译示例
npm run preview             # 预览效果（可选）
```

#### 许可证

遵循 [木兰宽松许可证第2版](LICENSE)。