grapesjs README

The project's README from github.com/GrapesJS/grapesjs. As one markdown file: README.md.

GrapesJS

Build Status Chat CDNJS npm

If you looking to embed the Studio editor in your application, we now offer the Studio SDK, a ready-to-use visual builder that's easy to embed in external applications, with GrapesJS team support included.

GrapesJS

GrapesJS is a free and open source Web Builder Framework which helps building HTML templates, faster and easily, to be delivered in sites, newsletters or mobile apps. Mainly, GrapesJS was designed to be used inside a CMS to speed up the creation of dynamic templates. To better understand this concept check the image below


GrapesJS - Style Manager


Generally any 'template system', that you'd find in various applications like CMS, is composed by the structure (HTML), style (CSS) and variables, which are then replaced with other templates and contents on server-side and rendered on client.

This demos show examples of what is possible to achieve:
Webpage Demo - http://grapesjs.com/demo.html
Newsletter Demo - http://grapesjs.com/demo-newsletter-editor.html

Table of contents

Features

Blocks Style Manager Layer Manager
GrapesJS - Block Manager GrapesJS - Style Manager GrapesJS - Layer Manager
Code Viewer Asset Manager
GrapesJS - Code Viewer GrapesJS - Asset Manager

Download

For the development purpose you should follow instructions below.

Usage

<link rel="stylesheet" href="path/to/grapes.min.css" />
<script src="path/to/grapes.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
    container: '#gjs',
    components: '<div class="txt-red">Hello world!</div>',
    style: '.txt-red{color: red}',
  });
</script>

For a more practical example I'd suggest looking up the code inside this demo: http://grapesjs.com/demo.html

Development

Follow the Contributing Guide.

Documentation

Check the getting started guide here: Documentation

API

API References could be found here: API-Reference

Testing

$ pnpm test

Plugins

Official Plugins | Community Plugins

Wrappers

Extensions

Presets

Find out more about plugins here: Creating plugins

Support

If you like the project and you wish to see it grow, please consider supporting us with a donation of your choice or become a backer/sponsor via Open Collective

PayPalMe Bitcoin


BrowserStack
Thanks to BrowserStack for providing us browser testing services

License

BSD 3-clause

grapesjs (GrapesJS/grapesjs)

rich-text-editor
Searching Database…

26.3K ·GitHub
What is this?GrapesJS is a free and open source Web Builder Framework for building HTML templates without coding — templates you can deliver in sites, newsletters or mobile apps.
Is it a hosted website builder I sign up for, or a piece of code I embed?It is a framework, not a hosted app: you embed the visual editor into your own JavaScript application — most commonly a CMS — to speed up creating dynamic templates.
How do I add it to a project?Install it from npm (npm i grapesjs), pull it from a CDN like UNPKG or CDNJS, or clone the git repo; the documentation includes a getting started guide.
Do I need anything installed to run it?Nothing special: it is a client-side TypeScript library loaded via npm or a CDN. Working on the repository itself requires Node 20+ and pnpm 9+.
Can non-developers build templates with it?Yes — end users assemble pages visually by dragging blocks onto the canvas, without coding; you only write code to embed and configure the editor in your app.
Is it really free, and can I use it in commercial projects?Yes — it is free and open source under the BSD 3-clause license.
What does the editor include out of the box?Blocks for drag-and-drop composition, a Style Manager, a Layer Manager, a Code Viewer and an Asset Manager, plus built-in commands and local and remote storage for saving your work.
Do I have to build the editor UI from scratch?No — official presets give ready-made builders (grapesjs-preset-webpage, grapesjs-preset-newsletter and grapesjs-mjml for MJML newsletters), and the @grapesjs/react wrapper lets you build a custom declarative UI for the editor.
Can it be extended with plugins?Yes — there are official and community plugins for things like zip export, a CKEditor-based RTE, forms, navbars, countdowns, custom fonts, tabs and touch support, and you can write your own.
What is the Studio SDK mentioned in the README?It is the GrapesJS team's ready-to-use visual builder that embeds into external applications, offered as an alternative to assembling your own editor on the framework, with team support included.
What are similar projects?puck, Kooboo, BlockNote, tui.editor, tinymce, lexical, ckeditor5, slate
Creator
GrapesJS
Size
111.4 MB
Stars
26.3K
Age
10y
Commits · 90 Days