搜索结果列表页面开发

src/components/renderer-yaml/api.md

@@ -0,0 +1,30 @@
+```
+    mock数据地址: renderer-yaml/mock/data.ts
+```
+### 预览组件
+1. 使用方式
+    ```js
+    import rendererPreview from '@/components/renderer-yaml/mode/preview'
+    ```
+2. Props
+
+| 参数 | 说明 | 类型 | 默认值 |
+| --- | --- | --- | --- |
+| content | yaml文件内容 | string | empty |
+
+### Form提交组件
+1. 使用方式
+    ```js
+    import rendererPreview from '@/components/renderer-yaml/mode/form'
+    ```
+2. Props
+| 参数 | 说明 | 类型 | 默认值 |
+| --- | --- | --- | --- |
+
+### Yaml 转换成 markdown协议字符串
+1. 使用方式
+    ```js
+    import toMarkdown from '@/components/renderer-yaml/helper/toMarkdown';
+    const markdown = toMarkdown(yamlContent);
+    console.log(markdown)
+    ```