💚用 Laravel 开发的一个轻松的 Markdown 文档编辑项目

Adoc

Just Another markdown doc editor

PHP 7.2 + Laravel 5.8 + React-Bootstrap

Feature

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

?github

github

安装

git clone https://github.com/yybawang/Adoc.git
cd Adoc
cp .env.example .env
  • 新建mysql/maraidb数据库,当然你可以选择其他数据库,运行迁移即可
    CREATE SCHEMA `adoc` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 
// 编辑配置文件中的 APP_URL、数据库、redis连接
vi .env

// 下载包
composer install

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

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

// 访问 APP_URL 测试
  • [x] 项目功能
    • [x] 项目新增
    • [x] 项目配置
    • [x] 项目权限分配,使用 gate
    • [x] 项目删除
    • [x] 项目所有权转移
    • [ ] 项目置顶,列表排前显示,替代排序功能
    • [ ] 项目tag标签
    • [ ] 列表可选使用 tag 分组展示
  • [x] 文档功能
    • [x] 文档增删改查
    • [x] 文档自定义模版
    • [x] 文档修改历史,对比、还原
    • [x] 文档模版
    • [x] markdown 编辑器图片上传,上传到 laravel 配置的 filesystem 配置中,默认 public
    • [x] 编辑器快捷键支持, Ctrl/Cmd + s 保存(停留当前页), Ctrl/Cmd + Shift + S 保存并返回
    • [ ] 文档编辑时可能已被修改过,提示合并
    • [x] 文档搜索,头部右上角,暂只支持搜索当前展示项目下文档
    • [x] 文档排序,默认时间先后顺序
    • [x] 文档附件

示例
示例
示例
示例
示例

本帖由系统于 2个月前 自动加精
yybawang
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
讨论数量: 15

大哥你把邮箱账号密码暴露

2个月前 评论
yybawang (楼主) 2个月前
命中水

有个小问题 ,我简历一个项目,开始在项目下写文档保存的时候,提示我project_id必须大于1


看了一下 发现是projects这个表 主键id没有设置自增,才造成的

Laravel

2个月前 评论
yybawang (楼主) 2个月前
命中水

file

2个月前 评论
yybawang

新增
editor.md 编辑/显示 使用等宽字体,避免空格排版、数字/符号显示不明显问题

2个月前 评论

这里的css都是你写的吗 厉害啊

2个月前 评论

:+1: 关注~

可以增加 api 导入导出文档

2个月前 评论
yybawang (楼主) 2个月前

从界面看,是扒了 showdoc 项目的皮?

2个月前 评论

刚好也在开发文档管理系统,标记一下回去看看 :grin:

2个月前 评论
fourn

安装的时候有碰到这个错误吗?
file
file

2个月前 评论
yybawang (楼主) 2个月前
晓鹤

github 风格文档历史对比

这个功能我这边点开都是 File without changes, 能说下具体文档历史对比的实现思路么

2个月前 评论
yybawang (楼主) 2个月前
晓鹤 (作者) 2个月前
oyghan

有点类似于showdoc哈!不错的项目 :+1:

1个月前 评论

file
老兄,能加拖动么,这样很别扭 :relaxed:

1个月前 评论
yybawang (楼主) 1个月前

楼主,你git的演示地址出问题了.

1个月前 评论
yybawang (楼主) 1个月前
Aolinver

很棒,关注!

2周前 评论

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!