← 返回博客

X-portal需求文档

Markdown · 需求文档 · 2026/06/11 09:01

1、整体页面来看,风格还算合适,我喜欢这种纯净极简的风格

2、具体到模块,现在有个管理,单拎出来,我觉得不合适,这个可以做成登录后仅我可见,比如做个头像-设置,不登录就是纯介绍、只读。且这里因该是本系统的相关设置页面,就比如github配置及同步,不应该放笔记管理相关的东西。

3、笔记模块,你认为在个人站点,加这个模块或者说起这个名字是否合适?要不要换一个名字?

4、笔记模块(也可能是别的名字,看上一条的情况),应该跟asset项目的运维知识库类似,只有登录后才可以查看到。

在模块内应该有如下功能:
4.1 导入:

4.1.1 有图md导入时若内部有图片链接(只接受图片存在assets目录的情形)则需要打包成zip导入;

4.1.2 无图md导入则正常处理;

4.1.3 若PDF导入也正常处理;

4.1.4 导入doc文章和ppt文章需要看情况,因为之前的项目你跟我提过,这个有难度,当时是一刀切全部转为pdf文章导入的

4.1.5 注意:导入的源文件作为附件匹配文章,在阅读页给一个位置可以一键下载附件(源文件)

4.1.6 需要写一个导入后批量编辑的入口,可以参考asset-运维知识库的处理逻辑

4.2 导出

4.2.1 若导入的是md文章,导出可选md、PDF、doc;

4.2.2 若导入的是pdf则导出只给pdf导出

4.2.3 若导入的是doc或ppt文章,这个要看导入的4.1.4如何设计,再做讨论

4.3 列表页(表格和卡片形式双模态)

a. 支持快速搜索(标题、内容、分类、标签)在搜索框输入文本即可快速搜索(无需回车或点击其他按钮,回退或删除文本即恢复)

b. 支持多选导出、删除、批量编辑

4.3.1 表格模式:

标题、分类、标签、更新时间,这四项在行内可以通过右侧下拉快速筛选(参考asset项目-运维知识库-列表页表格视图的实现);

支持快速多选(复选框)行内非标题处点击选择;
鼠标悬浮快速编辑;

4.3.2 卡片模式:

参考asset-运维知识库里的卡片设计

4.4 阅读

能够实时渲染MD阅读,注意格式

4.5 编辑页:

列表页要有快速编辑功能弹窗,标题、分类、标签等

文章进去再点编辑,若是MD文章就可以编辑正文,若是非MD文章,只可以编辑标题、分类、标签

4.6 注意:不需要草稿和发布状态,导入保存即可查看。