mangodoc

一个简单的doc文档构建器，采用微内核架构风格实现，使用插件机制来支持扩展。参考docsify和chatGPT。

在线demo

架构图

特性

• 简单文档：基于javascript实现的简单文档生成器。
• marked转换:基于marked实现markdown到html的转换。
• elementui风格：基于elementui的vue组件版本构建。
• 简单路由：基于es6中的fetch()加上window.location.hash实现路由。
• 静态部署：支持静态资源部署，如gitee pages、github pages等。
• 插件扩展：提供插件API接口，包括生命周期和部分事件监听函数。
• 支持vue：md内支持局部使用，详情参考例子。
• 接口api: 将内部配置暴露为window.$mangodocApi提供给外部插件调用。

插件列表

• 内置插件core - 支持文档布局、文档核心、hash路由、加载提示、接口api及插件机制
• 内置插件css - 支持内置样式嵌入
• 内置插件aside - 支持左侧目录栏配置和生成
• 内置插件nav - 支持顶部导航条配置和生成
• 内置插件prism - 基于prismjs支持代码高亮
• 外部插件mangodoc-giscus - 支持giscus评论
• 外部插件mangodoc-toc - 支持文章目录书签生成
• 外部插件mangodoc-imgview - 集成hammerjs支持图片点击查看和放大移动
• 外部插件mangodoc-top - 支持文章阅读时返回顶部
• 外部插件mangodoc-baidu-tj - 支持集成百度统计
• 外部插件mangodoc-plantuml - 支持集成plantuml
• 外部插件mangodoc-valine - 支持valine评论，匿名评论
• 外部插件mangodoc-busuanzi - 集成卜算子，显示网站访问信息
• 外部插件mangodoc-update-time - 显示文档最后修改时间

待办列表

• [x] （优化）优化nav上的更新日志链接，加上图标。
• [x] （优化）优化nav上的仓库链接，加上图标。
• [x] （优化）优化aside的激活颜色为主题色。
• [x] （优化）优化aside的标题logo在小屏下显示的尺寸。
• [x] （修复）修复mangodoc-update-time最后修改时间显示为Invalid Date的bug。
• [x] （修复）修复刷新文档内链接后，title显示为默认标题的bug。
• [x] （修复）修复aside的宽度初次显示不一致的问题，有时候宽有时候窄。
• [x] （优化）在footer内增加备案信息显示。
• [ ] （新特性）支持iconfont字体图标。
• [ ] （新插件）显示文档内容字数及大约阅读时间。
• [ ] （新插件）在文档末尾显示附近范围内的分页内容。
• [ ] （新特性）设计并支持文档封面页。
• [ ] （新插件）基于markmap支持思维导图，支持超链接跳转。