Adoc

Just Another markdown doc editor

PHP 7.2 + Laravel 5.8 + React-Bootstrap

Features

1. UI使用直角主题，以及不会腻的黑白色
2. 编辑快捷键添加 ctrl/cmd + shift + s 保存并返回
3. 添加了文档活动记录，暂无其他用途，只是个历史查看谁改动了哪些文档
4. github 风格文档历史对比
5. 添加文档附件功能
6. 编辑、展示和导出都使用 editor.md，(showdoc编辑和展示是两个不同的程序)
7. 文档菜单无限极分类(编辑父级同样)
8. 文档菜单滑动到顶部优化
9. 文档搜索
10. 编辑器/显示 使用等宽字体，避免空格排版、数字/符号显示不明显问题
11. JSON工具生成MD表格为字段增加了 padEnd 空格填充，使之都在一列，逼死强迫症功能
12. 文档左侧列表拖动排序(react-beautiful-dnd)，湿滑排序，强迫症福利

💚github

github

Demo 演示

https://adoc.thinkms.com/

安装

git clone https://github.com/yybawang/Adoc.git
cd Adoc
cp .env.example .env

// 编辑配置文件中的 APP_URL、数据库、redis连接
vi .env

• 新建mysql/maraidb数据库，当然你可以选择其他数据库，运行迁移即可

CREATE SCHEMA `adoc` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

• Linux/Mac 下 Makefile 一步安装

make && make install

// 访问 APP_URL 测试

• Windows 下手动步骤安装

// 下载包
composer install

// 生成key，数据库迁移等
php artisan key:generate
php artisan storage:link    // 导出下载时需要
php artisan migrate

// 下载 npm 包，进行前端编译
npm install
npm run prod

// 访问 APP_URL 测试

升级

• 更新代码和数据库迁移
• 更新前端

git pull
php artisan migrage
npm install && npm run prod

• 项目功能
  • 项目新增
  • 项目配置
  • 项目权限分配，使用 gate
  • 项目删除
  • 项目所有权转移
  • 项目置顶，列表排前显示，替代排序功能(只会影响当前用户，非全局排序)
  • 项目tag标签
  • 列表可选使用 tag 分组展示
• 文档功能
  • 文档增删改查
  • 文档自定义模版
  • 文档修改历史，对比、还原
  • 文档模版
  • markdown 编辑器图片上传，上传到 laravel 配置的 filesystem 配置中，默认 public
  • 编辑器快捷键支持， Ctrl/Cmd + s 保存(停留当前页)， Ctrl/Cmd + Shift + S 保存并返回
  • 文档编辑时可能已被修改过，提示合并
  • 文档搜索，头部右上角，暂只支持搜索当前展示项目下文档
  • 文档列表拖动排序
  • 文档附件
  • JSON工具，json 转MD表格，json 美化