Adoc

Just Another markdown doc editor

PHP 7.2 + Laravel 5.8 + React-Bootstrap

Feature

  1. The UI uses a right-angle theme
  2. Edit shortcut keys add CTRL/CMD + Shift + S to save and return
  3. Added document activity record, no other purpose, just a history to see who changed what document
  4. Github Style document history comparison
  5. Add document attachment function
  6. Editor. md is used for editing, showing, and exporting. (Showdoc editing and showing are two different programs)
  7. Document menu Infinite pole classification (edit parent same)
  8. The Document menu slides to the top to optimize
  9. Document search

💚 making

github

The installation

git clone https://github.com/yybawang/adoc.git
cd adoc
cp .env.example .env
Copy the code
  • Create a new mysql/ maraiDB database, of course you can choose another database, run the migration
CREATE SCHEMA `adoc` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 
Copy the code
Vi. Env // download package install // generate key, PHP artisan Key: Generate PHP artisan storage:link NPM install NPM run prod // Access the APP_URL testCopy the code
  • Project function
    • The new project
    • Project configuration
    • Project permissions are assigned, using Gate
    • delete
    • Project ownership transfer
    • Items are placed at the top of the list, instead of the sorting function
    • Item Tag
    • Lists are displayed in tag groups
  • Function of the document
    • Document add delete change check
    • Document custom templates
    • Document modification history, comparison, restore
    • The document template
    • Upload the markdown editor image to the Laravel filesystem configuration, public by default
    • Editor shortcut key support, Ctrl/Cmd + S save (stay on the current page), Ctrl/Cmd + Shift + S save and return
    • The document may have been modified during editing, prompting a merge
    • Document search, in the upper right corner of the header, only documents under the current project can be searched
    • Document sorting, default chronological order
    • The document in attachment