README

Admin panel for editing markdown documentation with GitHub PR workflow. Edit docs in a browser, create PRs automatically.

Features

• File tree sidebar with search
• Markdown editor with live preview (split view)
• SEO frontmatter management (title, description, keywords, noindex)
• Image upload (drag & drop, paste, file picker)
• GitHub PR workflow — every save creates a branch + PR
• Create and delete pages
• Fullscreen mode
• LocalStorage preferences (tab mode, SEO panel state)

Installation

composer require maloun96/laravel-docs-editor

Publish the config:

php artisan vendor:publish --tag=docs-editor-config

Configuration

Add to your .env:

DOCS_EDITOR_GITHUB_TOKEN=ghp_xxx
DOCS_EDITOR_GITHUB_OWNER=your-org
DOCS_EDITOR_GITHUB_REPO=your-repo
DOCS_EDITOR_GITHUB_BRANCH=main
DOCS_EDITOR_DOCS_PATH=docs
DOCS_EDITOR_MEDIA_PATH=public/docs-media
DOCS_EDITOR_ROUTE_PREFIX=admin/docs

Config options

Authorization

Register an auth callback in your AppServiceProvider:

use Maloun96\DocsEditor\DocsEditor;

DocsEditor::auth(function ($request) {
    return $request->user()?->isAdmin();
});

Publish views (optional)

php artisan vendor:publish --tag=docs-editor-views

GitHub Token

Create a fine-grained personal access token with:

• Repository access: Only the target repo
• Permissions: Contents (read/write), Pull requests (read/write)

License

MIT