Configure markup editing

WYSIWYG toolbar configuration#

Markdown is used in the Content, Visual, and Data Editors. The Content Editor is a rich text editor for Markdown files. The Visual Editor can edit Markdown files if they are wrapped in an HTML element. Markdown is also used in the Data Editor if you have a rich text area for one of your inputs. To customize your experience using these editors, you should configure your WYSIWYG toolbar.

Let’s go over an example of how you would customize the toolbar. We want to allow our content team to add a table to Markdown files. In our global configuration file, we have complete control over the WYSIWYG toolbar.

You can define the _editables for each editor type in the global configuration file. These sections look like this in the configuration GUI:

Select all the editable options you would like in your WYSIWYG toolbar.

When you have created your CloudCannon global configuration file, your _editables will look something like this:

_editables:
  content:
    bold: true
    italic: true
    bulletedlist: true
    numberedlist: true
    image: true
    table: true
    undo: true
    redo: true

{
  "_editables": {
    "content": {
      "bold": true,
      "italic": true,
      "bulletedlist": true,
      "numberedlist": true,
      "image": true,
      "table": true,
      "undo": true,
      "redo": true
    }
  }
}

As you can see, we have enabled many of the common functions your team would expect in a content editor. But that’s not all! Check out our documentation for many more ways to configure the WYSIWYG toolbar.

Markdown engine configuration#

Your Markdown engine will process Markdown into HTML, making it editable. You can use any Markdown engine when building your site; this only covers the Markdown content you edit inside CloudCannon.

CloudCannon supports the CommonMark and Kramdown specifications. These implementations are markdown-it (JavaScript) and kramdown (Ruby). markdown-it is the default Markdown processor in CloudCannon.

Currently, you cannot configure the Markdown engine through the Configuration GUI, however, it is easy to do manually. Navigate to your CloudCannon global configuration file through the Files tab in your navigation sidebar. The configuration file will be in the root of your directory.

Your generator code should look something like this:

generator:
  metadata:
    markdown: markdown-it
    markdown-it:
      html: true
      linkify: true

{
  "generator": {
    "metadata": {
      "markdown": "markdown-it",
      "markdown-it": {
        "html": true,
        "linkify": true
      }
    }
  }
}

The default configuration is { html: true } to allow the images with width and height attributes the Rich Text editors create. However, you can update this to match your site by setting the generator.metadata in your global configuration file as shown above.

Visual Editor Previews#

In a previous section of this guide, we talked about the Visual Editor — an intuitive way to edit your site by clicking directly on a preview of your page. But how do you make each region editable in the Visual Editor?

The Vue Connector is our open-source tool which listens for live editing events in the Visual Editor. CloudCannon will re-render your page as changes occur, generating a preview of your page as you edit.

The Vue Connector#

There are a few requirements for data previews in the Visual Editor:

• Components must have an output URL. If your site is built using the Nuxt Content module, components in the pages/ directory are a good example.
• Components must get their data from a data/content file somewhere in your project. This is critical, as the Visual Editor cannot open the components themselves.
• These data/content files must be configured as a CloudCannon Collection. See the CloudCannon Reader documentation for more information.
• Components will need to use the Vue onMounted and onBeforeUnmount hooks.

CloudCannon Vue Connector is available on npm. To install it, run the following terminal command:

npm i -D @cloudcannon/visual-editor-connector

Add the following code to any component that you want to add live editing to:

<script setup>
  import { onMounted, onBeforeUnmount, ref } from 'vue';
  import { onCloudCannonChanges, stopCloudCannonChanges } from '@cloudcannon/visual-editor-connector';

  const { page } = useContent();

  const pageData = ref(page.value);

  onMounted(async () => {
    onCloudCannonChanges((latestValue) => {
      pageData.value = latestValue;
    });
  });

  onBeforeUnmount(async () => {
    stopCloudCannonChanges();
  });
</script>

For an example integration, check out our Sendit Nuxt template, or reach out to our support team.