Git Product home page Git Product logo

nova-enhanced-markdown's Introduction

Laravel Nova Enhanced Markdown Field

A custom Markdown Field for Nova with image upload support

Stable Version License PHP Version Require

Features

  • For Laravel Nova ^4.0
  • Image upload
  • Accepts Drag & Drop / Copy & Paste

Installation

composer require ardenthq/nova-enhanced-markdown

Use

  1. Add the EnhancedMarkdown field to your Nova Resource.
<?php
namespace App\Nova;

use Laravel\Nova\Http\Requests\NovaRequest;
use Laravel\Nova\Resource;
use Ardenthq\EnhancedMarkdown\EnhancedMarkdown;

final class ResourceName extends Resource
{
    // ....
    public function fields(NovaRequest $request)
    {
        return [
            // ....
            EnhancedMarkdown::make('body'),
            // ...
        ];
    }
    // ...
}
  1. By default, this package only validates the attachment as an actual file. If you require more rules (let's say that you only want to accept images), define the rules with the new attachmentRules method.
EnhancedMarkdown::make('Content', 'content')
    ->attachmentRules('dimensions:min_width=20,min_height:20', 'image'),
  1. In some cases, you may want to parse the file before storing it (for example, apply some optimizations). To do that, you can add a callback by using the parseFile method.
EnhancedMarkdown::make('Content', 'content')
    ->parseFile(function (EnhancedMarkdown $field, UploadedFile $file) {
        $image = \Spatie\Image\Image::load($file->getPathname());
        $image->fit(\Spatie\Image\Manipulations::FIT_MAX, 100, 100);
        $image->save();
    });

If needed, you can also return a new instance of the file, that instance is the one that is going to be stored.

Important: You need to return an instance of Illuminate\Http\UploadedFile, Illuminate\Http\File or a string.

EnhancedMarkdown::make('Content', 'content')
    ->parseFile(function (EnhancedMarkdown $field, UploadedFile $file) {
        return new File('some/path');
    });
  1. The files are stored by default with / as a path and using public storage disk. You can change the path and the storage disk with the disk and path methods:
EnhancedMarkdown::make('Content', 'content')
    ->disk('s3')
    ->path('articles')

Development

  1. Run yarn nova:install and yarn install to install all the necessary dependencies for compiling the view components.
  2. Run yarn run dev (or yarn run watch) while making changes to the components in your local environment.
  3. If you change the vue components, ensure to compile for production before making a PR.

Compile for production

  1. Run yarn nova:install and yarn install to install all the necessary dependencies for compiling the view components.
  2. Run yarn run production.

Analyze the code with phpstan

composer analyse

Refactor the code with php rector

composer refactor

Format the code with php-cs-fixer

composer format

Run tests

composer test

Security

If you discover a security vulnerability within this package, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.

Credits

This project exists thanks to all the people who contribute.

License

MIT © Ardent

nova-enhanced-markdown's People

Contributors

itsanametoo avatar alfonsobries avatar 0528makoto avatar crnkovic avatar

Stargazers

Nurrohman Marduki avatar Sandalots avatar Hilman Ramadhan avatar Sergej Tihonov avatar anditsung avatar  avatar

Watchers

 avatar  avatar

nova-enhanced-markdown's Issues

Fullscreen is not scrollable

If you use the fullscreen button on the markdown editor and have enough text to require you to scroll, you will notice that you can't.

Notice that this seems to be a bug that is also present on the default built-in nova markdown editor,

Clicking add image button throws error in console

Not sure what's going on - but brand new install, try to add an image and getting this:

runtime-core.esm-bundler.js:226 TypeError: Cannot read properties of undefined (reading 'chunkSize')
    at Je (enhanced-markdown:2:88930)
    at ht (enhanced-markdown:2:90422)
    at Ca.replaceRange (enhanced-markdown:2:176941)
    at Proxy.insertBefore (enhanced-markdown:2:408324)
    at Proxy.image (enhanced-markdown:2:409885)
    at Proxy.callAction (enhanced-markdown:2:408504)
    at enhanced-markdown:2:412618
    at runtime-dom.esm-bundler.js:1482:16
    at nn (runtime-core.esm-bundler.js:155:22)
    at rn (runtime-core.esm-bundler.js:164:21)

If uploading to s3, is it possible to set the file as public?

I'm very new to using s3 storage—but I cannot figure out a way to set the uploaded image permission. I'm hoping to not have the entire bucket set as public.

EnhancedMarkdown::make('Body')
  ->hideFromIndex()
  ->alwaysShow()
  ->disk('s3')
  ->path('posts')
                

Would I need to use the parseFile() function somehow?

Thanks! I love the file up loads with the markdown field!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.