PHPackages artisansplatform/laravel-app-documentation-editor - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. artisansplatform/laravel-app-documentation-editor ActiveLibrary[Utility & Helpers](/categories/utility) artisansplatform/laravel-app-documentation-editor ================================================= Inline-injected Vite-powered document editor package 110PHP Since Nov 22Pushed 5mo agoCompare [ Source](https://github.com/artisansplatform/laravel-app-documentation-editor)[ Packagist](https://packagist.org/packages/artisansplatform/laravel-app-documentation-editor)[ RSS](/packages/artisansplatform-laravel-app-documentation-editor/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) Laravel App Documentation Editor ================================ [](#laravel-app-documentation-editor) Tired of switching between tools to update your docs? Our editor brings documentation management right into your Laravel app. Edit markdown files, preview changes instantly, and submit GitHub PRsβ€”all in one sleek interface. ✨ Features ---------- [](#-features) - **πŸ“ Modern Markdown Editor** - Rich editing with real-time preview - **πŸ”„ GitHub Integration** - Create pull requests without leaving your app - **πŸ”’ Flexible Authorization** - Control who can edit your documentation - **πŸ“± Responsive Design** - Works beautifully on all devices - **πŸ—‚οΈ Document Browser** - Navigate your project files with ease - **πŸ‘οΈ Visual Diffs** - Compare changes before submitting - **🧩 Event System** - Hook into editor events from your JavaScript πŸ“¦ Installation -------------- [](#-installation) ``` composer require artisansplatform/laravel-app-documentation-editor ``` πŸ”— Access URL ------------ [](#-access-url) ``` https://your-app.com/laravel-app-documentation-editor/documentation ``` > **Note:** The URL path can be customized in the configuration file using the `url_name` setting. βš™οΈ Configuration (Optional) --------------------------- [](#️-configuration-optional) Publish the configuration file to customize paths, GitHub integration, and access control: ``` php artisan vendor:publish --provider="Artisansplatform\LaravelAppDocumentationEditor\Providers\LaravelAppDocumentationEditorServiceProvider" --tag="laravel-app-documentation-editor-config" ``` This creates `config/laravel-app-documentation-editor.php` where you can set: - Document paths - GitHub repository details - Authorization methods - Custom URL name πŸ”’ Authorization --------------- [](#-authorization) Control who can edit your documentation using flexible authorization methods: - URL Parameters Method - Simple access control via URL parameters - Callback Method - Advanced control with custom logic [See detailed authorization documentation](AUTHORIZATION.md) πŸ”„ GitHub Integration -------------------- [](#-github-integration) Enable GitHub integration to submit document changes as pull requests: ``` // In your .env file LARAVEL_APP_DOCUMENTATION_EDITOR_GITHUB_TOKEN=your_token LARAVEL_APP_DOCUMENTATION_EDITOR_GITHUB_OWNER=your_username LARAVEL_APP_DOCUMENTATION_EDITOR_GITHUB_REPOSITORY=your_repo LARAVEL_APP_DOCUMENTATION_EDITOR_GITHUB_BASE_BRANCH=main ``` For detailed instructions on creating a GitHub token, see the [GitHub Token Creation Guide](github_token_creation.md). πŸ“‹ Requirements -------------- [](#-requirements) - PHP 8.2+ - Laravel 11.x - Composer 🀝 Contributing -------------- [](#-contributing) Contributions are welcome! Please feel free to submit a Pull Request. πŸ“„ License --------- [](#-license) This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). ✨ Credits --------- [](#-credits) - [Mishal Parmar](https://github.com/misusonu18) --- Made with ❀️ by [Artisans Platform](https://github.com/artisansplatform) ### Health Score 20 β€” LowBetter than 14% of packages Maintenance51 Moderate activity, may be stable Popularity7 Limited adoption so far Community8 Small or concentrated contributor base Maturity12 Early-stage or recently created project Bus Factor1 Top contributor holds 91.7% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/2628a8e3bd55b2ab1a2b4aaccb5a88d33854348c7a7d99e4f76f49c502692329?d=identicon)[gauravmak](/maintainers/gauravmak) --- Top Contributors [![misusonu18](https://avatars.githubusercontent.com/u/52093984?v=4)](https://github.com/misusonu18 "misusonu18 (33 commits)")[![gauravmak](https://avatars.githubusercontent.com/u/11887260?v=4)](https://github.com/gauravmak "gauravmak (3 commits)") ### Embed Badge ![Health badge](/badges/artisansplatform-laravel-app-documentation-editor/health.svg) ``` [![Health](https://phpackages.com/badges/artisansplatform-laravel-app-documentation-editor/health.svg)](https://phpackages.com/packages/artisansplatform-laravel-app-documentation-editor) ``` ### Alternatives [trentrichardson/cakephp-shrink Compiles, combines, and minifies javascript, coffee, less, scss, and css 1619.3k](/packages/trentrichardson-cakephp-shrink) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)