Usage no npm install needed!

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

README

Magnolia Template Annotations

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

Installation

npm install --save @magnolia/template-annotations

Usage

To use TemplateAnnotations, you need to import it:

import { TemplateAnnotations } from '@magnolia/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;

Changelog

See the CHANGELOG.md file.