PHPackages dinandmentink/nova-markdown - 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. [Parsing & Serialization](/categories/parsing) 4. / 5. dinandmentink/nova-markdown AbandonedArchivedLibrary[Parsing & Serialization](/categories/parsing) dinandmentink/nova-markdown =========================== A Laravel Nova Markdown Field. v5.0.2(2y ago)36137.1k↓18.4%4[4 issues](https://github.com/dinandmentink/nova-markdown/issues)MITPHPPHP >=8.1 Since Mar 14Pushed 2y ago2 watchersCompare [ Source](https://github.com/dinandmentink/nova-markdown)[ Packagist](https://packagist.org/packages/dinandmentink/nova-markdown)[ Docs](https://github.com/dinandmentink/nova-markdown)[ RSS](/packages/dinandmentink-nova-markdown/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (5)Versions (30)Used By (0) 🫑 EOL ===== [](#-eol) **This project is abandoned. Laravel v10 was the latest version supported by this package** This project is now EOL and will no longer be maintained. Please note that the [markdown field](https://nova.laravel.com/docs/4.0/resources/fields.html#markdown-field) included with laravel nova now supports file attachments. If you would like to maintain a successor of this project please make a fork and reach out to me so I can suggest it. Since Laravel Nova switched to a yearly fee with v4.0 I have looked around for a good alternative. I have decided to migrate all my personal projects and customers to [filament](https://filamentphp.com/). **❀️ I have happily maintained this project since 2019. Thanks for the pull requests, suggestions and other help. Thanks for using this package.** --- *Sidenote. I'm a bit angry with Laravel Nova switching to a yearly license. Which forced me, as a single-person-agency, to either abandon updates or pay yearly for some 30-ish customers. For my multi-tenant products Laravel Nova became completely unusable due to it's license. I highly recommend checking out filament as an open-source alternative.* Nova Markdown ============= [](#nova-markdown) [![Latest Version on Packagist](https://camo.githubusercontent.com/2d5173de2c74b3849586575da4034c307f28c2bf4df4bc095127317ee0b49865/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f64696e616e646d656e74696e6b2f6e6f76612d6d61726b646f776e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/dinandmentink/nova-markdown)[![Total Downloads](https://camo.githubusercontent.com/f64fd55ef9b2bad0303e03bfb872c93103d804846511742b4a33095fc5a51955/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f64696e616e646d656e74696e6b2f6e6f76612d6d61726b646f776e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/dinandmentink/nova-markdown)[![Forks](https://camo.githubusercontent.com/b44b2ede176043c0a3a212db2d9eef3312a74bff9c19572f39ae9a57575eac0b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f64696e616e646d656e74696e6b2f6e6f76612d6d61726b646f776e2e7376673f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/b44b2ede176043c0a3a212db2d9eef3312a74bff9c19572f39ae9a57575eac0b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f64696e616e646d656e74696e6b2f6e6f76612d6d61726b646f776e2e7376673f7374796c653d666c61742d737175617265)[![Stars](https://camo.githubusercontent.com/ea1d32cfaa593ea57637f9e66977723fc7603a869a388b36b67a1563a9170e47/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f64696e616e646d656e74696e6b2f6e6f76612d6d61726b646f776e2e7376673f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/ea1d32cfaa593ea57637f9e66977723fc7603a869a388b36b67a1563a9170e47/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f64696e616e646d656e74696e6b2f6e6f76612d6d61726b646f776e2e7376673f7374796c653d666c61742d737175617265)[![MIT license](https://camo.githubusercontent.com/37d70ed2dde8b585ba568a3727dc0d2672812dbac284e8158e794c5e05ddd130/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f64696e616e646d656e74696e6b2f6e6f76612d6d61726b646f776e2e7376673f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/37d70ed2dde8b585ba568a3727dc0d2672812dbac284e8158e794c5e05ddd130/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f64696e616e646d656e74696e6b2f6e6f76612d6d61726b646f776e2e7376673f7374796c653d666c61742d737175617265) Add a markdown editor field to Laravel Nova. Based on [easymde](https://github.com/Ionaru/easy-markdown-editor), Nova Markdown supports highlighting, some useful buttons and inline image uploads. It's simple, configurable, and it just worksβ„’. [![Nova Markdown](images/nova-markdown.gif)](images/nova-markdown.gif) Installation instructions ------------------------- [](#installation-instructions) Require `dinandmentink/nova-markdown` using composer: ``` composer require dinandmentink/nova-markdown ``` The package will register itself using Laravels' package autodiscovery. Now, whenever you want to use a Markdown field use `Markdown::make` like you would expect in the `fields()` method of a Nova resource. ``` use DinandMentink\Markdown\Markdown; public function fields(Request $request) { return [ Markdown::make("Field Name"), ]; } ``` It will accept all default Nova options: ``` use DinandMentink\Markdown\Markdown; public function fields(Request $request) { return [ Markdown::make("Content")->rules('required')->hideFromIndex(), ]; } ``` Nova Markdown uses [nova-packages-tool](https://github.com/nova-kit/nova-packages-tool) to provide a versioned `laravel-nova` mixin. Please ensure you have `@php artisan nova:publish` in your composer's `script.post-update-cmd` to [keep nova's assets updated](https://nova.laravel.com/docs/4.0/installation.html#keeping-nova-s-assets-updated). Versioning ---------- [](#versioning) Nova Markdown uses [semantic versioning](https://semver.org/) and aims to always support the latest major Laravel and Laravel Nova release. Only the latest major version for Nova Markdown will receive updates, it is recommended to upgrade to the latest version of Nova Markown whenever a new major version for Laravel or Laravel Nova drops. Nova MarkdownLaravelLaravel NovaMaintenancev5.xv10.xv4.xFeatures, Security, Bugsv4.xv9.xv4.xSecurityv3.xv9.xv3.xNonev2.xv8.xv3.xNoneImage uploads ------------- [](#image-uploads) Nova Markdown supports inline image uploads. To upload an image you can drag-and-drop it onto the markdown editor. Alternatively, pasting an image from your clipboard will also work. Image upload is enabled by default for all `Markdown` fields. It can be disabled entirely, or by default, through the config. Image upload can be enabled or disabled on a per-field basis, but this will *only* toggle the frontend implementation of image uploads. ``` use DinandMentink\Markdown\Markdown; public function fields(Request $request) { return [ Markdown::make("Field With Uploads")->uploads(), Markdown::make("Field Without Uploads")->uploads(false), ]; } ``` Image upload should just workβ„’. Nova Markdown aims to support image uploads on a vanilla laravel + nova project. The following assumptions must be met. It's possible to override most of these through the config. - A disk named `public` is assumed to be configured in `filesystems.php`. - Nova Markdown uses [spatie/image](https://github.com/spatie/image) for compressing and resizing images. Image requires the php [exif extension](http://php.net/manual/en/exif.installation.php) to be enabled. - Nova Markdown registers a route and a controller in the same middleware configured in `nova.middleware`. This assumes an authenticated user that may access Nova may also upload images through Nova Markdown's image upload route. Config ------ [](#config) Config mainly deals with image uploads. Sensible defaults are provided, but Nova Markdown aims to be fully configurable either through `config/nova-markdown.php` or env variables. For all configuration options please see the [default config](src/config/nova-markdown.php), which can be published: ``` php artisan vendor:publish --provider="DinandMentink\Markdown\FieldServiceProvider" ``` This will create a `config/nova-markdown.php` file in your app that you can modify to set your configuration. Please make sure you check for changes to the original config file in this package between releases. The following are some of the most usefull config items. **Enable uploads** Config key: `uploads` ENV: `NOVA_MARKDOWN_UPLOADS` Default: `true` Setting this to `false` will disable image uploads completely. **Enable uploads by default** Config key: `uploads-default-enabled` ENV: `NOVA_MARKDOWN_UPLOADS_DEFAULT_ENABLED` Default: `true` Will enable uploads by default (to be enabled on a per-field basis). Has no effect when uploads are disabled entirely. **Set disk** Config key: `disk` ENV: `NOVA_MARKDOWN_DISK` Default: `public` Set the disk where uploads are stored. Must be configured in `filesystems.php`. Note that Nova Markdown stores files with [visibility public](https://laravel.com/docs/filesystem#file-visibility) by default. This might override a disks' default private setting (`'visibility' => 'private'`) on a per-file basis. **File visibility** Config key: `file-visibility` ENV: `NOVA_MARKDOWN_FILE_VISIBILITY` Default: `public` Uploaded files will receive this as their visibility after uploading. Change to `'private'` to set files as not publicly visible or `null` to default to the disk's default. Note however that uploading files as `private` may disallow visitors from viewing them and you may have to introduce alternative means of displaying the files. **Directory** Config key: `directory` ENV: `NOVA_MARKDOWN_DIRECTORY` Default: `uploads` Set the directory where images are uploaded. Alternatively, it's possible to configure a function, which takes the uploading $user as argument and can be used to group files by user. Example: ``` function($user) { return "uploads/" . \Str::slug($user->name); } ``` **Maximum upload size** Config key: `max-size` ENV: `NOVA_MARKDOWN_MAX_SIZE` Default: `8 * 1024` The maximum size for uploaded images in kilobytes. **Maximum upload width** Config key: `max-width` ENV: `NOVA_MARKDOWN_MAX_WIDTH` Default: `1920` The maximum width for uploaded images in pixels. Uploaded images will be scaled down to this width. Use null to disable image scaling. **Image Quality** Config key: `quality` ENV: `NOVA_MARKDOWN_QUALITY` Default: `85` Uploaded images will be converted to this quality. Integer between 0 and 100. Use `null` to disable quality adjustments. **Random Filename** Config key: `random_filename` ENV: `NOVA_MARKDOWN_RANDOM_FILENAME` Default: `false` Uploaded images will be stored by default using a slug version of its original filename. You can set this to true to use a random filename instead. Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Rendering markdown ------------------ [](#rendering-markdown) Nova Markdown will add a markdown editor field to Nova. It does not render markdown outside Nova. For rendering the markdown in Laravel views I recommend having a look at [Laravel Markdown](https://github.com/GrahamCampbell/Laravel-Markdown) or [commonmark](https://github.com/thephpleague/commonmark). Difference with Nova's own markdown ----------------------------------- [](#difference-with-novas-own-markdown) Nova, ofcourse, offers it's own [markdown field](https://nova.laravel.com/docs/1.0/resources/fields.html#markdown-field). Nova's official markdown and this, Nova Markdown, are similar. Both of them offer inline text highlighting of markdown text. Neither of them perform transformations on the input and simply store it as plain text, usually in a TEXT column. This package however will add some more highlighting and toolbar buttons that are not included the default Markdown field. But mainly, **Nova Markdown handles image uploads**. FunctionalityDefault MarkdownNova MarkdownStrongVVItalicVVExternal imageVVLinkVVPreviewVVInline image upload-VHeadings-VBlockquotes-VOrdered lists-VUnordered lists-VSide-by-side view-VCredits ------- [](#credits) This project was proudly created and maintained by [Elementon](https://www.elementon.nl) since 2019. Elementon is a tiny webdevelopmment agency in the Netherlands. After Laravel Nova changed their license to a yearly fee Elementon decided to switch to [filament](https://filamentphp.com/) as an admin panel and therefor no longer actively maintain this project. ### Health Score 44 β€” FairBetter than 92% of packages Maintenance18 Infrequent updates β€” may be unmaintained Popularity42 Moderate usage in the ecosystem Community16 Small or concentrated contributor base Maturity80 Battle-tested with a long release history Bus Factor1 Top contributor holds 93.6% 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. ### Release Activity Cadence Every ~64 days Recently: every ~141 days Total 29 Last Release 808d ago Major Versions v0.4.2 β†’ v1.0.02020-04-28 v1.x-dev β†’ v2.0.02020-12-19 v2.x-dev β†’ v3.0.02022-03-03 v3.x-dev β†’ v4.0.02022-04-14 v4.2.1 β†’ v5.0.02023-02-23 PHP version history (3 changes)v0.1.0PHP >=7.1.0 v2.0.0PHP >=7.4 v5.0.0PHP >=8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/0f10bcbcd19000e9d7173d88cd92fc1f77c93e1e40ddf9904809becb6811c066?d=identicon)[dinandmentink](/maintainers/dinandmentink) --- Top Contributors [![dinandmentink](https://avatars.githubusercontent.com/u/17289887?v=4)](https://github.com/dinandmentink "dinandmentink (147 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (3 commits)")[![romanzipp](https://avatars.githubusercontent.com/u/11266773?v=4)](https://github.com/romanzipp "romanzipp (3 commits)")[![sanderkadastik](https://avatars.githubusercontent.com/u/56273204?v=4)](https://github.com/sanderkadastik "sanderkadastik (2 commits)")[![crynobone](https://avatars.githubusercontent.com/u/172966?v=4)](https://github.com/crynobone "crynobone (1 commits)")[![Fot0n](https://avatars.githubusercontent.com/u/6566055?v=4)](https://github.com/Fot0n "Fot0n (1 commits)") --- Tags highlightinglaravellaravel-novamarkdownmarkdown-editornovanova-markdownlaravelmarkdownfieldnovaImage upload ### Code Quality Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/dinandmentink-nova-markdown/health.svg) ``` [![Health](https://phpackages.com/badges/dinandmentink-nova-markdown/health.svg)](https://phpackages.com/packages/dinandmentink-nova-markdown) ``` ### Alternatives [dniccum/nova-documentation A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard. 37116.4k](/packages/dniccum-nova-documentation)[interaction-design-foundation/nova-html-card A Laravel Nova card to display arbitrary HTML content 67731.2k3](/packages/interaction-design-foundation-nova-html-card)[stepanenko3/nova-json Nova json field to spread a json column throughout multiple fields. 42249.7k](/packages/stepanenko3-nova-json) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)