feat: add custom editor API

[mathe42]

This PR is a rebased version of #308

Types of changes

• Bug fix (a non-breaking change which fixes an issue)
• New feature (a non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Description

With

content: {
   editor: '~/path/to/component/editor.vue'
}

you can define your own component for editing.

Your component should implement the following:

1. v-model for the markdown code
2. prop isEditing (optional)
3. when the edit is finished your component should emit endEdit

Resolves #303

Example

https://github.com/mathe42/content-editor

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes (if not applicable, please state why)

Tests

I think existing tests should be enough. I didn't touch the tests and they didn't break.

[mathe42]

Custom editor example

To test this with a custom editor (created by me :D ) follow this steps:

1. checkout my branch
2. run:

cd docs
yarn add nuxt-content-editor

3. add the following to the nuxt.config.js:

  content: {
    editor: '../../../node_modules/nuxt-content-editor/editor.vue',
  },

We have to use this relative path as editor.vue has to be comp-/transpiled
4. run yarn dev
5. checkout the docs at localhost:3000

[mathe42]

@benjamincanac This is ready for review.

[atinux]

I think this need tests as well as using alias resolution + suggested changes

[mathe42]

Todos

• Requestet changes
• Alias resolution
• testing

Alias resolution

As I understand you mean pathes like @/components/editor.vue or ~/components/editor.vue this should work out of the box...

Pathes like 'myNPMpackage/editor.js' are working too.

Testing

What has to be tested?

• editor options works and replaces component
• editor options works with alias e.g. ~/components/editor.vue
• default editor works as expected (old tests handle this)

[mathe42]

@atinux
Added some thoughts what we can test. I will try to implement them next week. If I missed something just tell me. 👍

[mathe42]

@atinux added some tests...

[mathe42]

@benjamincanac @atinux is there any progress on the review?

[atinux]

Hi @mathe42

We were on holidays this week.
Will review the coming week, overall looks great!