diff --git a/readme.md b/readme.md index 6b0a38a4a0b3f4d4b9dc6f0bc968354b71610b97..3ac87e1ca2b2c5b69b1132c081de1b88d164c112 100644 --- a/readme.md +++ b/readme.md @@ -1,48 +1,61 @@ -
-- A NoBI platform that Connect Data to Insight. -
- - - - - -### 功能特色 -- 数据可视化,大屏,移动报表,数据中台,WEB应用的微代码NoBI(No Only BI)开发平台 -- 简单, 敏捷, 高效, 通用化, 高度可定制化, 让你的项目瞬间档次提升 -- 完全真正打通前后端, 支持图形数据联动,筛选,钻取, 支持几乎常见的所有数据库 -- 积木式拖拽开发模式, 开箱即用, 安装简单, 依赖少, 适应各种平台 -- 支持中国式报表类EXCEL开发, 支持3D场景大屏 -- 内存加速技术, 让你的数据快人一步, 大幅减少数据库压力 -- 真所见即所得的拖拽开发模式, 且无需在画布上设计 -- 支持数据填报设计,数据下载,前端埋点,问卷开发 -- 数据集即服务, 采用低代码快速实现数据服务API开发 -- 支持仪表盘备份恢复快照等, 满足企业级的版本控制开发上线流程要求 -- 支持用户/组功能权限控制,支持行级别/字段级别数据权限控制 -- 支持Django插件方式应用,可无限扩展,打造你专属的个性化应用 -- 支持在Jupyter notebook中的数据开发方式应用 -- 支持集成chatGPT, 文心一言等大模型AI生成 -- 没有重复学习成本, 高度可定制化, 注意是高度可定制化!! \ No newline at end of file + +根据代码地图,该项目是一个基于静态站点生成的文档系统,其结构与布局主要由HTML、CSS及部分JavaScript库构成,可能基于类似Hugo或GitBook的文档框架。以下为该项目的README.md内容: + +```markdown +# 文档项目 + +这是基于静态站点生成的文档项目,提供简洁、美观的界面来展示技术文档、指南、API参考等内容。 + +## 功能特色 + +- **响应式布局**:支持多种屏幕尺寸,适配移动端和桌面端。 +- **全文搜索**:通过集成FlexSearch,实现快速文档内容搜索。 +- **多语言支持**:可扩展的语言结构,便于国际化。 +- **数学公式渲染**:集成KaTeX,支持在文档中渲染LaTeX数学公式。 +- **Mermaid图表支持**:支持Mermaid语法,可在文档中生成流程图、时序图等可视化图表。 +- **离线支持**:通过Service Worker(sw.js)实现文档的离线访问能力。 +- **清晰的导航结构**:左侧菜单支持多级分类导航,右侧可展示目录结构(Table of Contents)。 +- **代码高亮**:支持Markdown中的代码块高亮展示,提供良好的代码阅读体验。 + +## 应用案例 + +- 技术文档 +- API接口说明 +- 项目使用手册 +- 开源项目说明文档 + +## 目录结构说明 + +- `content/`:文档内容主目录,包含Markdown文件。 +- `docs/`:静态站点生成后的输出目录,包含HTML、CSS、JS等资源。 +- `docs/index.html`:主页入口文件。 +- `docs/book.min.css`:站点样式文件。 +- `docs/katex/`:数学公式渲染相关资源。 +- `docs/mermaid.min.js`:Mermaid图表渲染支持。 +- `docs/sw.js`:Service Worker脚本,用于离线访问。 + +## 开始使用 + +1. **克隆仓库** + + ```bash + git clone <仓库地址> + ``` + +2. **运行站点** + + 可将`docs/`目录部署至任意静态服务器,例如使用Nginx、Apache或GitHub Pages。 + +3. **添加内容** + + 在`content/`目录下添加或修改Markdown文档,系统会自动构建并生成导航。 + +## 贡献指南 + +欢迎提交Issue或PR,帮助我们优化文档结构或增加新功能。请确保遵循项目的代码规范和提交约定。 + +## 许可证 + +本项目遵循 [MIT License](LICENSE)。 +``` \ No newline at end of file