1 Star 0 Fork 0

mgang / mangodoc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

mangodoc

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

在线demo

架构图

布局说明

default的主题布局

类似后台管理布局,严谨规整。

simple的主题布局

去掉大部分border,更加简约,不受条条框框限制。

特性

  • 简单文档:基于javascript(1.x)或者typescript(2.x)实现的简单文档生成器。
  • 脚手架工具:支持mangodoc工具快速创建文档模板并启动。
  • marked转换:基于marked实现markdownhtml的转换。
  • elementui风格:基于elementui的vue组件版本构建。
  • 简单路由:基于es6中的fetch()加上window.location.hash实现路由。
  • 静态部署:支持静态资源部署,如gitee pagesgithub pagesdockerpaas http server等。
  • 插件扩展:提供插件API接口,包括生命周期和部分事件监听函数。
  • 支持vue:md内支持局部使用,详情参考例子
  • 接口api: 将内部配置暴露为window.$mangodocApi提供给外部插件调用。
  • 内置主题: 支持2款内置主题,分别是defaultsimple

插件列表

  • 内置插件core - 支持文档布局、文档核心、hash路由、加载提示、接口api及插件机制
  • 内置插件css - 支持内置样式嵌入
  • 内置插件aside - 支持左侧目录栏配置和生成
  • 内置插件nav - 支持顶部导航条配置和生成
  • 内置插件prism - 基于prismjs支持代码高亮
  • 内置插件pageconfig - 支持页面配置
  • 内置插件alert - 支持alert告警格式文本
  • 内置插件link - 支持link链接格式文本
  • 内置插件tab - 支持tab标签格式文本
  • 外部插件mangodoc-giscus - 支持giscus评论
  • 外部插件mangodoc-toc - 支持文章目录书签生成
  • 外部插件mangodoc-imgview - 集成hammerjs支持图片点击查看和放大移动
  • 外部插件mangodoc-top - 支持文章阅读时返回顶部
  • 外部插件mangodoc-baidu-tj - 支持集成百度统计
  • 外部插件mangodoc-plantuml - 支持集成plantuml
  • 外部插件mangodoc-valine - 支持valine评论,匿名评论
  • 外部插件mangodoc-busuanzi - 集成卜算子,显示网站访问信息
  • 外部插件mangodoc-update-time - 显示文档最后修改时间
MIT License Copyright (c) 2023 mango mei Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

mangodoc like docsify tool 展开 收起
JavaScript
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/mgang/mangodoc.git
git@gitee.com:mgang/mangodoc.git
mgang
mangodoc
mangodoc
master

搜索帮助