功能介绍与页面显示效果 ## 一、基础核心功能 ### 1. 无构建实时渲染 - **功能介绍**:直接将 Markdown 文档渲染为网页,无需编译步骤,修改文档后刷新页面即可实时生效。 - **页面显示**: - 访问核心文件 `index.html` 时,自动加载根目录 `README.md` 作为首页,Markdown 语法(标题、列表、链接、图片等)会被渲染为简洁美观的网页样式,无多余杂乱元素。 - 修改 Markdown 内容后,刷新浏览器立即呈现最新效果,无任何编译等待时间;页面仅加载当前访问的文档,即使文档数量众多,首次打开速度依然流畅。 ### 2. 极简文件结构 - **功能介绍**:无需复杂项目目录,仅需 1 个核心配置文件 + 若干 Markdown 文档,即可搭建完整文档站。 - **页面显示**: - 目录结构直观,仅包含核心文件和文档,维护时无需关注冗余文件;访问任意 Markdown 文档时,URL 路径与文件名对应(如 `install.md` 对应 `#/install`),易记易用。 - 页面无额外构建产物残留,视觉上简洁干净,聚焦文档内容本身。 ## 二、导航体系功能 ### 1. 侧边栏(自动/自定义) - **功能介绍**:支持两种模式——自动生成(基于当前文档标题层级)和自定义配置(跨文档多级导航),是文档站核心导航入口。 - **页面显示**: - 自动模式:左侧显示当前文档的标题列表(层级匹配设置的最大级别,如 1-3 级),点击标题可快速跳转到对应内容,当前激活标题高亮显示。 - 自定义模式:左侧显示手动配置的多级导航列表,一级目录默认展开,二级及以下目录缩进显示;支持用分隔线划分模块,视觉上清晰分组。 - 移动端适配:小屏幕下侧边栏自动折叠为左上角“菜单按钮”,点击可展开导航,不占用正文显示空间。 - 交互效果:点击侧边栏链接,右侧内容区平滑切换到对应文档,同时页面自动滚动到顶部,方便阅读。 ### 2. 顶部导航栏 - **功能介绍**:补充横向导航,适合放置全局功能(如首页跳转、版本切换、外部链接、语言切换等)。 - **页面显示**: - 页面顶部呈现一条横向导航栏,左侧显示文档站名称,右侧排列配置的导航项,文字清晰易读。 - 带子菜单的导航项(如“版本”“语言”),鼠标悬浮时会弹出下拉列表,点击列表项可跳转;外部链接点击后默认在新标签页打开,避免离开当前文档站。 ### 3. 面包屑导航 - **功能介绍**:自动生成当前页面的路径导航,帮助用户快速定位所在位置,便于回溯上级目录。 - **页面显示**: - 正文内容区顶部显示路径导航(如“首页 > 功能详解 > 侧边栏”),路径分隔符默认为 `>`,颜色为浅灰色,与正文区分明显。 - 每个路径段均为可点击链接,点击可直接跳转到对应层级的文档,操作便捷。 ## 三、阅读体验增强功能 ### 1. 全文搜索 - **功能介绍**:纯前端实现全文检索,无需后端服务,支持自定义搜索范围、占位符和无结果提示。 - **页面显示**: - 页面右上角设置搜索框,默认显示自定义占位符(如“搜索文档...”),样式简洁不突兀。 - 输入关键词后,实时显示匹配的文档标题和内容片段,匹配关键词用黄色背景高亮;无搜索结果时,显示自定义提示文字(如“没有找到相关内容 😞”)。 - 搜索结果按相关性排序,支持上下键切换选中项,回车快速跳转,交互流畅。 ### 2. 流程图/时序图(Mermaid) - **功能介绍**:直接在 Markdown 中编写流程图、时序图、思维导图等,无需外部画图工具,文档与图形一体化管理。 - **页面显示**: - 渲染后呈现可视化图形,节点为圆角矩形或指定样式,分支带文字标注,线条流畅。 - 支持多种图形类型(流程图、时序图、甘特图、思维导图等),样式简洁统一,与文档整体风格协调,无需额外调整格式。 ### 3. 其他实用小功能 | 功能 | 功能介绍 | 页面显示效果 | |--------------|-----------------------------------|-----------------------------------------------| | 回到顶部 | 页面滚动后快速返回顶部 | 右下角出现圆形“↑”按钮,悬浮时颜色加深,点击后平滑滚动到页面顶部 | | 图片缩放 | 支持图片放大查看,适配不同尺寸图片 | 点击图片后,图片居中放大显示,背景变暗,支持滚轮缩放、ESC 关闭或点击空白处关闭 | | 字数统计 | 统计文档字数与预估阅读时长 | 页面底部显示“字数:XXX | 阅读时长:X 分钟”,文字颜色浅灰,不干扰正文阅读 | | 自定义 404 | 访问不存在路径时显示自定义页面 | 显示配置的 404 文档内容(如引导返回首页、搜索文档等),样式与整体文档站一致 | ### 2. 移动端适配 - **功能介绍**:默认响应式设计,自动适配手机、平板等不同尺寸设备。 - **页面显示**: - 手机端:侧边栏折叠为菜单按钮,顶部导航栏自适应宽度,文字、图片、代码块自动缩放,无横向滚动条;所有交互功能(搜索、代码复制、图片缩放)均可正常使用,操作便捷。 - 平板端:侧边栏可手动折叠/展开,内容区适配屏幕宽度,排版整齐,阅读体验接近桌面端。