Usage no npm install needed!

<script type="module">
  import robsisTemplateAnnotations from 'https://cdn.skypack.dev/@robsis/template-annotations';
</script>

README

Magnolia Template Annotations

Magnolia Template Annotations help making front-end projects' content editable in Magnolia. + It does so by injecting annotations (HTML comments really) around your components/templates, which Magnolia's Page Editor transforms into controls for web content authors/editors.

Installation

npm install --save @robsis/template-annotations

Usage

To use TemplateAnnotations, you need to import it from mgnl-service:

import { TemplateAnnotations } from '@robsis/template-annotations';

TemplateAnnotations module provides these functions:

function getAreaCommentString(data: object, templateDefinition: object, componentCount?: number): string;
function getComponentCommentString(data: object, templateDefinition: object): string;
function getPageCommentString(data: object, templateDefinition: object): string;