?用 Laravel 開發的一個輕鬆的 Markdown 文件編輯專案

yybawang發表於2019-07-04

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] 文件附件

示例
示例
示例
示例
示例

本作品採用《CC 協議》,轉載必須註明作者和本文連結

相關文章