Getting Started

The section below assumes that you are using the default UI, which is built using React. The AlloyEditor core is fully separated from the UI and creating another one based on any other framework is very easy.

1 - Download AlloyEditor

Option 1) Download AlloyEditor from here, then unzip it.

Option 2) Install AlloyEditor via Bower (bower install alloyeditor)

Option 3) Install AlloyEditor via NPM (npm install alloyeditor)

2 - Copy and Paste

If you downloaded the zip file:

<link href="alloy-editor/assets/alloy-editor-ocean-min.css" rel="stylesheet">
<script src="alloy-editor/alloy-editor-all-min.js"></script>

If you downloaded it via Bower:

<link href="bower_components/alloyeditor/dist/alloy-editor/assets/alloy-editor-ocean-min.css" rel="stylesheet">
<script src="bower_components/alloyeditor/dist/alloy-editor/alloy-editor-all-min.js"></script>

3 - Use AlloyEditor

Invoke the editable static method on AlloyEditor passing the ID of the node you want to edit
AlloyEditor.editable('myContentEditable');

And that is everything you need to get started!

comments powered by Disqus