TobyQu/Adoc

📄🔧轻松的的 API MD文档编写工具

HTML

Adoc

Just Another markdown doc editor

PHP 7.2 + Laravel 5.8 + React-Bootstrap

Features

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

💚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